Skip to content

docs: sync guides, README, examples and notebooks with master - #54

Merged
afloresep merged 1 commit into
masterfrom
docs/sync-with-master
Nov 3, 2026
Merged

afloresep merged 1 commit into
masterfrom
docs/sync-with-master

Conversation

@afloresep

@afloresep afloresep commented Nov 3, 2026 •

Copy link
Copy Markdown
Owner

Brings the documentation up to date with the current API on master.

Changes

  • Guides (docs/*.md): rewritten for the current API, including input routing (USearch for binary/dense input, MinHash + LSHForest for sets, strings and sparse input), LayoutConfig fields and the untangle pass.
  • README: documents hops_from, the tmap.graph analysis 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.
  • Notebooks: text and cleanup passes. Two renames: 04_new_functionalities → 04_working_with_a_fitted_model and 12_legacy_lsh_pipeline → 12_lower_level_pipeline.
  • Examples: small fixes to molecules_tmap.py and word_embeddings_tmap.py. Removes examples/chemistry/smiles_tmap.py (the step-by-step low-level pipeline); notebooks/12_lower_level_pipeline.ipynb now covers it and molecules_tmap.py points there.

Related

Part of #53. The broken pages on tmap2.gdb.tools are fixed in the tmap website repo, the guides here keep relative .md links so they still work on GitHub, and the website rewrites them to its routes.

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.
@afloresep
afloresep merged commit bca1fae into master Nov 3, 2026
7 checks passed
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