docs: point install at PyPI and add CI and PyPI badges - #3
Merged
Conversation
deepspotm 1.0.0 is on PyPI, so the install instructions no longer need the "when published" caveat or the git URL as the primary path. - README: `pip install deepspotm` is now the headline install, with the `[wsi]` extra documented for the predict_wsi.py example and the git install kept as the way to track the development branch. - Add a CI badge and a PyPI version badge. - Replace the hardcoded "Python 3.9+" badge with the dynamic pyversions badge. It was stale: requires-python is >=3.10, because torch, transformers, peft and lightning all require >=3.10. Reading it from PyPI keeps it honest if that floor moves again. - examples/predict_tcga_skcm.ipynb: install line goes back to `pip install deepspotm`, which now resolves. A downloads badge was left out deliberately; PyPI download stats are not populated yet and it currently renders as "package not found".
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
1 participant
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.
deepspotm 1.0.0 is live on PyPI, so the README no longer needs the "when published" caveat.
pip install deepspotmis now the headline install; the[wsi]extra is documented forpredict_wsi.py, and the git URL is kept as the way to track the development branch.Python 3.9+badge with the dynamicpypi/pyversionsbadge. It was stale:requires-pythonis>=3.10because torch, transformers, peft and lightning all require it. Reading the value from PyPI keeps it correct if that floor moves again.examples/predict_tcga_skcm.ipynbinstall line goes back topip install deepspotm, which now resolves.Every badge URL was checked to render before committing. A downloads badge was left out on purpose: PyPI stats are not populated yet and it currently renders as "package not found". Worth adding in a day or so.