Skip to content

Adding links to the most useful of the old reference docs #595

Merged
mtauraso merged 2 commits intomainfrom
mtauraso/docs-reference
Jan 16, 2026
Merged

Adding links to the most useful of the old reference docs #595
mtauraso merged 2 commits intomainfrom
mtauraso/docs-reference

Conversation

@mtauraso
Copy link
Copy Markdown
Collaborator

This makes the old docs easily findable while we are doing the docs sprint.

…stuff is findable while we're re-vamping things
@mtauraso mtauraso requested review from Copilot and drewoldag and removed request for Copilot January 16, 2026 19:03
@mtauraso mtauraso self-assigned this Jan 16, 2026
@mtauraso mtauraso requested a review from gitosaurus January 16, 2026 19:08
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.31%. Comparing base (a934816) to head (12d34dd).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #595   +/-   ##
=======================================
  Coverage   62.31%   62.31%           
=======================================
  Files          53       53           
  Lines        5235     5235           
=======================================
  Hits         3262     3262           
  Misses       1973     1973           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@gitosaurus gitosaurus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


* :doc:`Builtin Datasets <autoapi/hyrax/data_sets/index>` - Different datasets that come pre-built within Hyrax.
* :doc:`Custom Datasets and Models <external_libraries>` - How to create your own dataset class and model within Hyrax.
* :doc:`Verbs <verbs>` - Description of the various \"verbs\" that Hyrax supports, such as ``train``, ``infer`` etc.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, do these quotes truly need to be escaped?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without the escaping we get smart quotes.

@mtauraso mtauraso merged commit 1c438b0 into main Jan 16, 2026
10 checks passed
@mtauraso mtauraso deleted the mtauraso/docs-reference branch January 16, 2026 19:17
@github-actions
Copy link
Copy Markdown

Before [a934816] After [d648900] Ratio Benchmark (Parameter)
8.34±0.1ms 8.69±0.2ms 1.04 vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(64, 'chromadb')
1.62G 1.66G 1.03 vector_db_benchmarks.VectorDBInsertBenchmarks.peakmem_load_vector_db(16384, 'chromadb')
378±0ms 389±0.8ms 1.03 vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(128, 'qdrant')
33.7±0.7ms 34.2±0.8ms 1.02 benchmarks.time_nb_obj_dir
6.71±0s 6.86±0.01s 1.02 vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(2048, 'qdrant')
1.74±0.02s 1.75±0.04s 1.01 benchmarks.time_help
1.71±0.02s 1.73±0.03s 1.01 benchmarks.time_lookup_help
1.01G 1.02G 1.01 vector_db_benchmarks.VectorDBInsertBenchmarks.peakmem_load_vector_db(2048, 'chromadb')
9.56±0.06s 9.70±0.03s 1.01 vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(16384, 'chromadb')
505±5ms 512±3ms 1.01 vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(256, 'chromadb')

Click here to view all benchmarks.

gitosaurus pushed a commit that referenced this pull request Feb 3, 2026
…stuff is findable while we're re-vamping things (#595)
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.

2 participants