docs: point PyPI at the Python docs, and say what len(q) counts - #108
Merged
Merged
Conversation
PyPI's Documentation link went to docs.rs, which documents the Rust API, and Homepage to the PyPI page itself. They now go to the python folder on GitHub, whose README is the Python docs, and to the repository. len(q) of a 256 x 512 tensor is 131,072, the number of values as in Rust, where NumPy would say 256, and nothing said so. The Quantized docstring and the README now do, and say that q.shape gives the rows and columns.
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.
PyPI links. The project's
Documentationlink went to docs.rs, which documents the Rust API, andHomepagewent to the PyPI page itself. They now go to thepythonfolder on GitHub, whose README is the Python docs, and to the repository. The built wheel's metadata lists all three.len(q). For a 256×512 layer,len(q)is 131,072, the number of values, as Rust'slen()is. NumPy would say 256, and nothing said which it was:help(Quantized.__len__)only prints Python's "Return len(self)." The behavior stays, since changing it after 0.3.0 would break code:Quantizeddocstring sayslen(q)is the number of values,rows * columnsfor a matrix, as in Rust, and thatshapegives the rows and columnsPyPI keeps each release's links and README as uploaded, so this is worth having in 0.3.0. Merges cleanly with #101, #103, #106, and #107.
just lint,just test, andjust pythonpass.