Skip to content

Commit 3065970

Browse files
committed
references with placeholder for FAQ
Signed-off-by: Marta Stepniewska-Dziubinska <[email protected]>
1 parent 7ceaa7f commit 3065970

File tree

4 files changed

+23
-33
lines changed

4 files changed

+23
-33
lines changed

docs/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -399,12 +399,10 @@ Setup & Installation <troubleshooting/setup-issues/index>
399399
Runtime & Execution <troubleshooting/runtime-issues/index>
400400
::: -->
401401

402-
<!-- :::{toctree}
402+
:::{toctree}
403403
:caption: References
404404
:hidden:
405405

406406
About References <references/index>
407-
Eval Parameters <evaluation/parameters>
408-
Eval Utils <references/evaluation-utils>
409-
API Documentation <apidocs/index.rst>
410-
::: -->
407+
FAQ <references/faq>
408+
:::

docs/references/evaluation-utils.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
orphan: true
3+
---
4+
15
(evaluation-utils-reference)=
26

37
# Evaluation Utilities Reference

docs/references/faq.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Frequently Asked Questions
2+
3+
TBD

docs/references/index.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
orphan: true
3-
---
4-
51
(references-overview)=
62

73
# References
@@ -13,47 +9,36 @@ Comprehensive reference documentation for NeMo Evaluator APIs, functions, and co
139
::::{grid} 1 2 2 2
1410
:gutter: 1 1 1 2
1511

16-
:::{grid-item-card} {octicon}`terminal;1.5em;sd-mr-1` Launcher API
17-
:link: ../libraries/nemo-evaluator-launcher/api
18-
:link-type: doc
19-
Complete Python API reference for programmatic evaluation workflows and job management.
20-
:::
2112

22-
:::{grid-item-card} {octicon}`command-palette;1.5em;sd-mr-1` CLI Reference
13+
:::{grid-item-card} {octicon}`command-palette;1.5em;sd-mr-1` NeMo Evaluator Launcher CLI
2314
:link: ../libraries/nemo-evaluator-launcher/cli
2415
:link-type: doc
2516
Comprehensive command-line interface reference with all commands, options, and examples.
2617
:::
2718

28-
:::{grid-item-card} {octicon}`gear;1.5em;sd-mr-1` Configuration Schema
29-
:link: ../libraries/nemo-evaluator-launcher/configuration/index
19+
:::{grid-item-card} {octicon}`terminal;1.5em;sd-mr-1` NeMo Evaluator Launcher API
20+
:link: ../libraries/nemo-evaluator-launcher/api
3021
:link-type: doc
31-
Complete configuration reference with examples for all executors and deployment types.
22+
Complete Python API reference for programmatic evaluation workflows and job management.
3223
:::
3324

34-
:::{grid-item-card} {octicon}`tools;1.5em;sd-mr-1` Evaluation Utilities
35-
:link: ../libraries/nemo-evaluator/workflows/python-api
25+
:::{grid-item-card} {octicon}`gear;1.5em;sd-mr-1` Configuration Schema
26+
:link: ../libraries/nemo-evaluator-launcher/configuration/index
3627
:link-type: doc
37-
Reference for evaluation discovery, health checking, and utility functions.
28+
Configuration reference for NeMo Evaluator Launcher with examples for all executors and deployment types.
3829
:::
3930

40-
:::{grid-item-card} {octicon}`code;1.5em;sd-mr-1` Auto-Generated API Docs
41-
:link: ../apidocs/index
42-
:link-type: doc
43-
Sphinx-generated API documentation for all modules and classes.
44-
:::
4531

46-
:::{grid-item-card} {octicon}`list-unordered;1.5em;sd-mr-1` Evaluation Parameters
47-
:link: ../evaluation/custom-tasks
32+
:::{grid-item-card} {octicon}`command-palette;1.5em;sd-mr-1` NeMo Evaluator CLI
33+
:link: ../libraries/nemo-evaluator/cli
4834
:link-type: doc
49-
Complete guide to evaluation parameters, optimization settings, and configuration patterns.
35+
Comprehensive command-line interface reference with all commands, options, and examples.
5036
:::
5137

52-
:::{grid-item-card} {octicon}`database;1.5em;sd-mr-1` Benchmark Catalog
53-
:link: ../evaluation/benchmarks
38+
:::{grid-item-card} {octicon}`terminal;1.5em;sd-mr-1` NeMo Evaluator API
39+
:link: ../../../apidocs/index
5440
:link-type: doc
55-
Comprehensive catalog of 100+ benchmarks across 18 evaluation harnesses.
41+
Complete Python API reference for programmatic evaluation workflows and job management.
5642
:::
5743

5844
::::
59-

0 commit comments

Comments
 (0)