Adding Core concepts page

[drewoldag]

Core concepts with links to "what you need to provide", "config system" and "data flow"

[Copilot]

Pull request overview

This pull request adds a "Core Concepts" section to the Hyrax documentation. The PR creates an introductory page that organizes three essential documentation topics: required inputs for Hyrax, the configuration system, and data flow through the framework.

Changes:

• Added a new required_input.rst file explaining the three essential inputs users must provide (model, data, and data preparation function)
• Expanded core_concepts.rst with an introduction and a table of contents linking to three conceptual documentation pages

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
docs/required_input.rst	New documentation page explaining the three essential inputs (model, dataset, and data preparation function) that users must provide to Hyrax
docs/core_concepts.rst	Updated to add introductory content and a toctree linking to three core concept pages (required inputs, configuration system, and data flow)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.31%. Comparing base (56ebbb8) to head (b550f04).
⚠️ Report is 223 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #596   +/-   ##
=======================================
  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.

[gitosaurus]

LGTM! Minor feedback only.

[github-actions]

Before [56ebbb8]	After [d5b9e05]	Ratio	Benchmark (Parameter)
8.40±0.1ms	8.81±0.2ms	1.05	vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(64, 'chromadb')
2.74±0.01s	2.79±0.01s	1.02	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(256, 'qdrant')
1.71±0.01s	1.73±0.03s	1.01	benchmarks.time_visualize_help
9.50±0.01s	9.59±0.03s	1.01	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(16384, 'chromadb')
1.42±0.01s	1.43±0.01s	1.01	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(2048, 'chromadb')
503±6ms	507±3ms	1.01	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(256, 'chromadb')
401±4ms	403±4ms	1.01	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(64, 'chromadb')
8.43±0.06ms	8.54±0.2ms	1.01	vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(128, 'chromadb')
382±1ms	386±0.6ms	1.01	vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(128, 'qdrant')
385±1ms	389±2ms	1.01	vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(64, 'qdrant')

Click here to view all benchmarks.

[dougbrn]

I think this looks great, in my opinion it would benefit a lot from some short example snippets, or links to other pages with examples (now or sometime later in the doc sprint). Fully optional though and will approve!

[drewoldag]

@dougbrn Good call out here - I've added a little diagram at the top (not code) and I've linked to the getting started docs for specifying the model and dataset. I'll add a link to the to_tensor function when we get a good notebook set up.