Repository navigation
Rewrite the README, fix the docs badge and the dark-mode live_info table - #502
Merged
Merged
Conversation
- Restructure the README: centered logo and title, the animations right after a plain summary, a short feature list, a quick start with a script and a Jupyter example, a learner table, executors, documentation links, and a table of the optional extras. - Use the shields.io Read the Docs badge; the readthedocs.org badge redirects and does not load as an image. Add a tests badge and drop the GitHub stars badge. - Drop the doctoc table of contents (GitHub shows an outline) and the TOC generator workflow that maintained it. - In dark mode, give the white widget card the light theme colors, so the rows of the live_info table are no longer dark.
Go back to the voice of the original README: plain sentences instead of a bold-labelled feature list and tagline, the learner list instead of a table, and the installation and development steps as before. The docs home page no longer includes the removed feature list. Set extra.generator = false so the footer no longer says "Made with Zensical".
- Make the script example self-contained (it used peak from the notebook example) and show to_numpy() in it. - Say that adaptive is meant for functions of a few parameters. - Explain what the loss function is and point to the built-in alternatives and the custom loss tutorial. - Say that the runners use all local cores by default, how to pass another executor, and link the parallelism tutorial. - Install with plain pip install adaptive; the [notebook] extra adds live plotting and pandas for to_dataframe(). - Development: add the test command; the notebook git filter needs nbconvert and only matters for example-notebook.ipynb. - Move the animation caption into the summary snippet, so the docs home page shows it too; label the conda downloads badge; fix the CQUAD link. - Parallelism tutorial: drop the stale claim that Windows defaults to distributed.Client; loky is the default everywhere.
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.
Description
A pass over the README and a few small docs fixes.
README:
BlockingRunnernext to the notebook example, and a line onto_numpy()/to_dataframe().pip install adaptiveas the install line, with the[notebook]extra explained; the development section has the test command and a correct note on the notebook git filter.readthedocs.orgredirects toapp.readthedocs.org), so it now usesimg.shields.io/readthedocs/adaptive. Added a tests badge for the nox workflow and dropped the GitHub stars badge.Docs:
live_infotable had dark rows with black text inside the white widget card, because the theme gives tables a dark background. The card now uses the light theme colors.extra.generator = false).distributed.Client; loky is the default everywhere.Both README examples were run: the script with
BlockingRunner, and the notebook one withlive_info/live_plot.Checklist
pre-commit runon the changed filespytestpassed (docs and CSS only;uv run --group docs pytest docs/ -o addopts=""passes, andzensical build --strictreports no issues)Type of change