Skip to content
This repository was archived by the owner on Sep 18, 2024. It is now read-only.

Update config v2 doc #3711

Merged
merged 9 commits into from
Jun 8, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en_US/Tutorial/ExperimentConfig.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Experiment Config Reference
===========================
Experiment Config Reference (legacy)
====================================

This is the previous version (V1) of experiment configuration specification. It is still supported for now, but we recommend users to use `the new version of experiment configuration (V2) <../reference/experiment_config.rst>`_.

A config file is needed when creating an experiment. The path of the config file is provided to ``nnictl``.
The config file is in YAML format.
Expand Down
3 changes: 3 additions & 0 deletions docs/en_US/Tutorial/QuickStart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ Three steps to start an experiment
codeDir: .
gpuNum: 0


.. _nniignore:

.. Note:: If you are planning to use remote machines or clusters as your :doc:`training service <../TrainingService/Overview>`, to avoid too much pressure on network, we limit the number of files to 2000 and total size to 300MB. If your codeDir contains too many files, you can choose which files and subfolders should be excluded by adding a ``.nniignore`` file that works like a ``.gitignore`` file. For more details on how to write this file, see the `git documentation <https://git-scm.com/docs/gitignore#_pattern_format>`__.

*Example:* :githublink:`config.yml <examples/trials/mnist-pytorch/config.yml>` and :githublink:`.nniignore <examples/trials/mnist-pytorch/.nniignore>`
Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ References
:maxdepth: 2

nnictl Commands <Tutorial/Nnictl>
Experiment Configuration <Tutorial/ExperimentConfig>
Experiment Configuration V2 <reference/experiment_config>
Experiment Configuration <reference/experiment_config>
Experiment Configuration (legacy) <Tutorial/ExperimentConfig>
Search Space <Tutorial/SearchSpaceSpec>
NNI Annotation <Tutorial/AnnotationSpec>
SDK API References <sdk_reference>
Expand Down
Loading