Skip to content

[codex] Improve new user install and scheduling docs#418

Merged
saulshanabrook merged 1 commit into
mainfrom
codex/new-user-usability-docs
Jun 18, 2026
Merged

[codex] Improve new user install and scheduling docs#418
saulshanabrook merged 1 commit into
mainfrom
codex/new-user-usability-docs

Conversation

@saulshanabrook

@saulshanabrook saulshanabrook commented Jun 18, 2026

Copy link
Copy Markdown
Member

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-python users and fills in missing scheduling reference details.

  • Add pip and uv install paths to the README and usage reference.
  • Replace the conda-only getting-started notebook setup with pip and uv examples for Python 3.11+.
  • Remove the stale conda-only docs/environment.yml file.
  • Expand scheduling reference docs for run, saturate, * n, +, seq, and the backoff scheduler, including defaults, times_banned behavior, scheduler scoping, and :until limits.
  • Add matching public docstrings for the Python schedule helpers.
  • Update Cargo.lock's local package version to match Cargo.toml so 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

  • Fresh pip source install in .tmp/new-user-install-pip, then import/run smoke test.
  • Fresh uv source install in .tmp/new-user-install-uv, then import/run smoke test.
  • Imported egglog.examples.schedule_demo in 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.

@saulshanabrook saulshanabrook marked this pull request as ready for review June 18, 2026 18:20
@codspeed-hq

codspeed-hq Bot commented Jun 18, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 12 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing codex/new-user-usability-docs (295cfbd) with main (590864a)

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@saulshanabrook saulshanabrook merged commit 0c25eaf into main Jun 18, 2026
24 checks passed
@saulshanabrook saulshanabrook deleted the codex/new-user-usability-docs branch June 18, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant