Files
obikmer/mkdocs.yml
T
Eric Coissac fe38424682 Implement batch lookup and chunked data management
Introduces support for batched MPHF lookups, chunked data handling via `SlottedKmers`, and a comprehensive benchmarking suite to measure performance across the indexing and querying pipeline.

This includes new layer functionality for batch operations, chunking logic in the query layer, and scripts to measure wall time and resource usage for various commands. Documentation related to specific implementation details has also been cleaned up.
2026-10-15 12:14:51 +02:00

75 lines
2.8 KiB
YAML

site_name: obikmer
docs_dir: DevDocMD
site_dir: DevDoc
theme:
name: material
plugins:
- mermaid2:
- bibtex:
bib_file: DevDocMD/references.bib
csl_file: DevDocMD/ecology-letters.csl
enable_inline_citations: false
markdown_extensions:
- admonition
- footnotes
- tables
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
extra_javascript:
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
nav:
- Home: index.md
- Installation: installation.md
- Theory:
- Kmers and super-kmers: kmers.md
- DNA encoding: theory/encoding.md
- Entropy filter: theory/entropy.md
- Minimizer selection: theory/minimizer.md
- Partitioning architecture: theory/indexing.md
- Chance sharing across genomes (discussion): theory/chance_sharing.md
- Central-position SNP distance (discussion): theory/evolutionary_distances.md
- Sibling partition unification (discussion): theory/sibling_partition_unification.md
- Pair-coverage-biased family sampling (discussion): theory/pair_coverage_sampling.md
- Implementation:
- SuperKmer: implementation/superkmer.md
- Kmer: implementation/kmer.md
- Chunk reader: implementation/chunkreader.md
- Construction pipeline: implementation/pipeline.md
- obipipeline library: implementation/obipipeline.md
- On-disk storage: implementation/storage.md
- MPHF selection: implementation/mphf.md
- "MPHF batch queries (inventory)": implementation/mphf_batch_queries.md
- Unitig evidence encoding: implementation/unitig_evidence.md
- Evidence elimination (discussion): implementation/evidence_elimination.md
- obikindex layer tier: implementation/layer_tier.md
- PersistentCompactIntVec: implementation/persistent_compact_int_vec.md
- PersistentBitVec: implementation/persistent_bit_vec.md
- Merge command: implementation/merge.md
- Merge parallelism & memory: implementation/merge_parallelism.md
- Kmer filtering: implementation/filtering.md
- Select command: implementation/select.md
- obitaxonomy crate: implementation/obitaxonomy.md
- "Benchmark: query-path testing": implementation/benchmark_query_testing.md
- "Partition and layer caching (discussion)": implementation/partition_layer_cache.md
- Architecture:
- Sequences: architecture/sequences/invariant.md
- Kmer index: architecture/index_architecture.md
- Sibling annex: architecture/siblings.md
- Hot resume and memoization: architecture/hot_resume_memoization.md
- NUMA-aware worker pools: architecture/numa_worker_pools.md
- NUMA-aware partition runner: architecture/numa_partition_runner.md
watch:
- DevDocMD
- mkdocs.yml