Repository navigation
docs: add a core concepts notebook - #224
Merged
Merged
Conversation
Explain what a Phylo2Vec vector encodes, adapted from the background and methods of Neil Scheidwasser's PhD thesis and the Phylo2Vec papers: phylogenetic trees and the size of tree space, why a vector, node and branch labels, the vector definition, ordered and unordered vectors, vector -> tree and Newick -> vector conversions, the matrix format for branch lengths, and the complexity of the conversions. Each claim is checked by a code cell (e.g., 105 vectors map to 105 distinct trees with 5 leaves). - Add the thesis TikZ figures as SVGs in docs/notebooks/img/ (fixing "Label the parent of 1 as 8" -> "3" in the relabelling figure) - Move "Other tree formats" from getting-started to core concepts - Link core concepts from the other notebooks - Add core concepts to the table of contents and the CI notebook job Related to sbhattlab#170 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Summary
Adds a Core concepts notebook between Getting started and Tree operations, explaining what a Phylo2Vec vector encodes. Related to #170; follows up on #222.
The text and figures are adapted from the background and methods of Neil Scheidwasser's PhD thesis and the Phylo2Vec papers. Each claim is checked by a code cell against the current code (e.g., the 105 vectors with 5 leaves map to 105 distinct trees, and each step of the vector → tree figure matches
to_newick).Contents
v[j] ∈ {0, ..., 2j}, ordered and unordered vectorsFigures
The thesis TikZ figures are added as SVGs in
docs/notebooks/img/, with a white background so that they render in dark themes. One fix compared to the thesis: the last row of the relabelling figure now reads "Label the parent of 3 as 8" (it said 1).Other changes
_toc.ymland the CI notebook job include the new notebook