Repository navigation
docs: sync guides, README, examples and notebooks with master - #54
Merged
Merged
Conversation
Rewrite the docs guides and README for the current API (input routing, hops_from, install extras, tmap.graph analysis helpers), rename notebooks 04 and 12 to describe their content, and drop the redundant examples/chemistry/smiles_tmap.py.
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.
Brings the documentation up to date with the current API on
master.Changes
docs/*.md): rewritten for the current API, including input routing (USearch for binary/dense input, MinHash + LSHForest for sets, strings and sparse input),LayoutConfigfields and the untangle pass.hops_from, thetmap.graphanalysis helpers (boundary_edges,subtree_purity,path_properties) and the install extras (tmap2[chemistry],[notebook],[proteins],[singlecell],[all]). It also clarifies that the__main__guard is needed on every platform.04_new_functionalities→04_working_with_a_fitted_modeland12_legacy_lsh_pipeline→12_lower_level_pipeline.molecules_tmap.pyandword_embeddings_tmap.py. Removesexamples/chemistry/smiles_tmap.py(the step-by-step low-level pipeline);notebooks/12_lower_level_pipeline.ipynbnow covers it andmolecules_tmap.pypoints there.Related
Part of #53. The broken pages on tmap2.gdb.tools are fixed in the tmap website repo, the guides here keep relative
.mdlinks so they still work on GitHub, and the website rewrites them to its routes.