ApiReference.rst 2.5 KB
Newer Older
QuanluZhang's avatar
QuanluZhang committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Retiarii API Reference
======================

.. contents::

Inline Mutation APIs
--------------------

..  autoclass:: nni.retiarii.nn.pytorch.LayerChoice
    :members:

..  autoclass:: nni.retiarii.nn.pytorch.InputChoice
    :members:

15
16
17
18
19
20
..  autoclass:: nni.retiarii.nn.pytorch.ValueChoice
    :members:

..  autoclass:: nni.retiarii.nn.pytorch.ChosenInputs
    :members:

21
22
23
24
25
26
..  autoclass:: nni.retiarii.nn.pytorch.Repeat
    :members:

..  autoclass:: nni.retiarii.nn.pytorch.Cell
    :members:

QuanluZhang's avatar
QuanluZhang committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Graph Mutation APIs
-------------------

..  autoclass:: nni.retiarii.Mutator
    :members:

..  autoclass:: nni.retiarii.Model
    :members:

..  autoclass:: nni.retiarii.Graph
    :members:

..  autoclass:: nni.retiarii.Node
    :members:

..  autoclass:: nni.retiarii.Edge
    :members:

..  autoclass:: nni.retiarii.Operation
    :members:

QuanluZhang's avatar
QuanluZhang committed
48
49
Evaluators
----------
QuanluZhang's avatar
QuanluZhang committed
50

51
..  autoclass:: nni.retiarii.evaluator.FunctionalEvaluator
QuanluZhang's avatar
QuanluZhang committed
52
53
    :members:

54
..  autoclass:: nni.retiarii.evaluator.pytorch.lightning.LightningModule
55
56
    :members:

57
..  autoclass:: nni.retiarii.evaluator.pytorch.lightning.Classification
58
59
    :members:

60
..  autoclass:: nni.retiarii.evaluator.pytorch.lightning.Regression
QuanluZhang's avatar
QuanluZhang committed
61
62
63
64
65
    :members:

Oneshot Trainers
----------------

66
..  autoclass:: nni.retiarii.oneshot.pytorch.DartsTrainer
QuanluZhang's avatar
QuanluZhang committed
67
68
    :members:

69
..  autoclass:: nni.retiarii.oneshot.pytorch.EnasTrainer
QuanluZhang's avatar
QuanluZhang committed
70
71
    :members:

72
..  autoclass:: nni.retiarii.oneshot.pytorch.ProxylessTrainer
QuanluZhang's avatar
QuanluZhang committed
73
74
    :members:

75
..  autoclass:: nni.retiarii.oneshot.pytorch.SinglePathTrainer
QuanluZhang's avatar
QuanluZhang committed
76
77
    :members:

78
79
Exploration Strategies
----------------------
QuanluZhang's avatar
QuanluZhang committed
80

81
..  autoclass:: nni.retiarii.strategy.Random
QuanluZhang's avatar
QuanluZhang committed
82
83
    :members:

84
85
86
87
88
89
90
..  autoclass:: nni.retiarii.strategy.GridSearch
    :members:

..  autoclass:: nni.retiarii.strategy.RegularizedEvolution
    :members:

..  autoclass:: nni.retiarii.strategy.TPEStrategy
QuanluZhang's avatar
QuanluZhang committed
91
92
    :members:

93
94
95
..  autoclass:: nni.retiarii.strategy.PolicyBasedRL
    :members:

QuanluZhang's avatar
QuanluZhang committed
96
97
98
Retiarii Experiments
--------------------

99
..  autoclass:: nni.retiarii.experiment.pytorch.RetiariiExperiment
QuanluZhang's avatar
QuanluZhang committed
100
101
    :members:

102
..  autoclass:: nni.retiarii.experiment.pytorch.RetiariiExeConfig
QuanluZhang's avatar
QuanluZhang committed
103
    :members:
104

105
106
107
108
109
110
111
112
113
CGO Execution
-------------

..  autofunction:: nni.retiarii.evaluator.pytorch.cgo.evaluator.MultiModelSupervisedLearningModule

..  autofunction:: nni.retiarii.evaluator.pytorch.cgo.evaluator.Classification

..  autofunction:: nni.retiarii.evaluator.pytorch.cgo.evaluator.Regression

114
115
116
Utilities
---------

117
118
119
..  autofunction:: nni.retiarii.basic_unit

..  autofunction:: nni.retiarii.model_wrapper
120
121

..  autofunction:: nni.retiarii.fixed_arch
122
123