Specify `training service <../TrainingService/Overview.html>`__.
Specify `training service <../TrainingService/Overview.rst>`__.
type: `TrainingServiceConfig`_
AlgorithmConfig
===============
^^^^^^^^^^^^^^^
``AlgorithmConfig`` describes a tuner / assessor / advisor algorithm.
For custom algorithms, there are two ways to describe them:
1. `Register the algorithm <../Tuner/InstallCustomizedTuner.rst>`__ to use it like built-in. (preferred)
2. Specify code directory and class name directly.
[TODO:short description]
name
----
Name of built-in or registered [TODO:link] algorithm.
Name of built-in or registered algorithm.
type: ``str`` for built-in and registered algorithm, ``None`` for custom algorithm
type: ``str`` for built-in and registered algorithm, ``None`` for other custom algorithm
class name
----------
className
---------
Qualified class name of custom algorithm.
Qualified class name of not registered custom algorithm.
type: ``str`` for custom algorithm, ``None`` for built-in and registered algorithm
type: ``None`` for built-in and registered algorithm, ``str`` for other custom algorithm
example: ``"my_tuner.MyTuner"``
code directory
--------------
codeDirectory
-------------
`Path`_ to directory containing the custom algorithm class.
type: ``Optional[str]`` for custom algorithm, ``None`` for built-in and registered algorithm
type: ``None`` for built-in and registered algorithm, ``str`` for other custom algorithm
If not specified, the `class name`_ will be looked up in Python's `module search path <https://docs.python.org/3/tutorial/modules.html#the-module-search-path>`__
class args
----------
classArgs
---------
Keyword arguments passed to algorithm class' constructor.
...
...
@@ -284,19 +365,22 @@ See algorithm's document for supported value.
TrainingServiceConfig
=====================
^^^^^^^^^^^^^^^^^^^^^
One of following:
- `LocalConfig`_
- `RemoteConfig`_
- `OpenPaiConfig`_
- `LocalConfig`_
- `RemoteConfig`_
- `OpenpaiConfig <openpai-class>`_
- `AmlConfig`_
For other training services, we suggest to use `v1 config schema <../Tutorial/ExperimentConfig.rst>`_ for now.
