[codex] Improve new user install and scheduling docs#418
Merged
Conversation
Merging this PR will not alter performance
Comparing Footnotes
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you @AYadrov and friends for the feedback! Still need to work on a larger docs refactor. Keep it coming!
Summary
This PR improves the first-run experience for new
egglog-pythonusers and fills in missing scheduling reference details.docs/environment.ymlfile.run,saturate,* n,+,seq, and the backoff scheduler, including defaults,times_bannedbehavior, scheduler scoping, and:untillimits.Cargo.lock's local package version to matchCargo.tomlso source installs do not dirty the checkout.Why
Users reported installation friction and undeclared-dependency symptoms. A fresh source install now resolves and runs through both pip and uv, and the docs no longer point new users at a conda-only environment path.
The scheduling docs also had the core examples, but did not comprehensively describe the Python schedule composition forms or backoff scheduler behavior.
Validation
.tmp/new-user-install-pip, then import/run smoke test..tmp/new-user-install-uv, then import/run smoke test.egglog.examples.schedule_demoin both fresh environments.uv run pytest --benchmark-disable -q python/tests/test_high_level.py::TestScheduler python/tests/test_pretty.py(92 passed).make docs(succeeded; existing Sphinx/gallery warning noise remains).git diff --check.