autotune_ref.md 1.88 KB
Newer Older
QuanluZhang's avatar
QuanluZhang committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Python API Reference of Auto Tune

```eval_rst
.. contents::
```

## Trial

```eval_rst
..  autofunction:: nni.get_next_parameter
..  autofunction:: nni.get_current_parameter
..  autofunction:: nni.report_intermediate_result
..  autofunction:: nni.report_final_result
..  autofunction:: nni.get_experiment_id
..  autofunction:: nni.get_trial_id
..  autofunction:: nni.get_sequence_id
```

## Tuner

```eval_rst
..  autoclass:: nni.tuner.Tuner
    :members:

25
..  autoclass:: nni.algorithms.hpo.hyperopt_tuner.hyperopt_tuner.HyperoptTuner
QuanluZhang's avatar
QuanluZhang committed
26
27
    :members:

28
..  autoclass:: nni.algorithms.hpo.evolution_tuner.evolution_tuner.EvolutionTuner
QuanluZhang's avatar
QuanluZhang committed
29
30
    :members:

31
..  autoclass:: nni.algorithms.hpo.smac_tuner.SMACTuner
QuanluZhang's avatar
QuanluZhang committed
32
33
    :members:

34
..  autoclass:: nni.algorithms.hpo.gridsearch_tuner.GridSearchTuner
QuanluZhang's avatar
QuanluZhang committed
35
36
    :members:

37
..  autoclass:: nni.algorithms.hpo.networkmorphism_tuner.networkmorphism_tuner.NetworkMorphismTuner
QuanluZhang's avatar
QuanluZhang committed
38
39
    :members:

40
..  autoclass:: nni.algorithms.hpo.metis_tuner.metis_tuner.MetisTuner
QuanluZhang's avatar
QuanluZhang committed
41
42
    :members:

43
..  autoclass:: nni.algorithms.hpo.ppo_tuner.PPOTuner
QuanluZhang's avatar
QuanluZhang committed
44
45
    :members:

46
..  autoclass:: nni.algorithms.hpo.batch_tuner.batch_tuner.BatchTuner
QuanluZhang's avatar
QuanluZhang committed
47
48
    :members:

49
..  autoclass:: nni.algorithms.hpo.gp_tuner.gp_tuner.GPTuner
QuanluZhang's avatar
QuanluZhang committed
50
51
52
53
54
55
56
57
58
59
60
61
    :members:
```

## Assessor

```eval_rst
..  autoclass:: nni.assessor.Assessor
    :members:

..  autoclass:: nni.assessor.AssessResult
    :members:

62
..  autoclass:: nni.algorithms.hpo.curvefitting_assessor.CurvefittingAssessor
QuanluZhang's avatar
QuanluZhang committed
63
64
    :members:

65
..  autoclass:: nni.algorithms.hpo.medianstop_assessor.MedianstopAssessor
QuanluZhang's avatar
QuanluZhang committed
66
67
68
69
70
71
    :members:
```

## Advisor

```eval_rst
72
..  autoclass:: nni.runtime.msg_dispatcher_base.MsgDispatcherBase
QuanluZhang's avatar
QuanluZhang committed
73
74
    :members:

75
..  autoclass:: nni.algorithms.hpo.hyperband_advisor.hyperband_advisor.Hyperband
QuanluZhang's avatar
QuanluZhang committed
76
77
    :members:

78
..  autoclass:: nni.algorithms.hpo.bohb_advisor.bohb_advisor.BOHB
QuanluZhang's avatar
QuanluZhang committed
79
80
    :members:
```
81
82
83
84
85
86

## Utilities

```eval_rst
..  autofunction:: nni.utils.merge_parameter
```