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

Commit dcd883d

Browse files
committed
docs: Add base to API docs
Signed-off-by: John Andersen <[email protected]>
1 parent ca96c32 commit dcd883d

File tree

4 files changed

+55
-50
lines changed

4 files changed

+55
-50
lines changed

docs/api/base.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Base
2+
====
3+
4+
.. automodule:: dffml.base
5+
:members:
6+
:undoc-members:

docs/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ API Reference
66
:maxdepth: 2
77
:caption: Contents:
88

9+
base
910
df/index
1011
feature
1112
repo

docs/plugins/dffml_model.rst

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,22 @@ Implemented using Tensorflow's DNNClassifier.
123123
124124
**Args**
125125

126-
- directory: String
126+
- classification: String
127127

128-
- default: /home/user/.cache/dffml/tensorflow
129-
- Directory where state should be saved
128+
- Feature name holding classification value
129+
130+
- classifications: List of strings
131+
132+
- Options for value of classification
133+
134+
- features: List of features
135+
136+
- Features to train on
137+
138+
- clstype: Type
139+
140+
- default: <class 'str'>
141+
- Data type of classifications values
130142

131143
- steps: Integer
132144

@@ -138,28 +150,16 @@ Implemented using Tensorflow's DNNClassifier.
138150
- default: 30
139151
- Number of iterations to pass over all repos in a source
140152

153+
- directory: String
154+
155+
- default: /home/user/.cache/dffml/tensorflow
156+
- Directory where state should be saved
157+
141158
- hidden: List of integers
142159

143160
- default: [12, 40, 15]
144161
- List length is the number of hidden layers in the network. Each entry in the list is the number of nodes in that hidden layer
145162

146-
- classification: String
147-
148-
- Feature name holding classification value
149-
150-
- classifications: List of strings
151-
152-
- Options for value of classification
153-
154-
- clstype: locate
155-
156-
- default: <class 'str'>
157-
- Data type of classifications values (default: str)
158-
159-
- features: List of feature.loads
160-
161-
- Features to train on
162-
163163
tfdnnr
164164
~~~~~~
165165

@@ -254,10 +254,13 @@ predict).
254254

255255
**Args**
256256

257-
- directory: String
257+
- predict: String
258258

259-
- default: /home/user/.cache/dffml/tensorflow
260-
- Directory where state should be saved
259+
- Feature name holding target values
260+
261+
- features: List of features
262+
263+
- Features to train on
261264

262265
- steps: Integer
263266

@@ -269,19 +272,16 @@ predict).
269272
- default: 30
270273
- Number of iterations to pass over all repos in a source
271274

275+
- directory: String
276+
277+
- default: /home/user/.cache/dffml/tensorflow
278+
- Directory where state should be saved
279+
272280
- hidden: List of integers
273281

274282
- default: [12, 40, 15]
275283
- List length is the number of hidden layers in the network. Each entry in the list is the number of nodes in that hidden layer
276284

277-
- predict: String
278-
279-
- Feature name holding truth value
280-
281-
- features: List of feature.loads
282-
283-
- Features to train on
284-
285285
dffml_model_scratch
286286
-------------------
287287

@@ -353,19 +353,19 @@ hash of their feature names.
353353
354354
**Args**
355355

356-
- directory: String
357-
358-
- default: /home/user/.cache/dffml/scratch
359-
- Directory where state should be saved
360-
361356
- predict: String
362357

363358
- Label or the value to be predicted
364359

365-
- features: List of feature.loads
360+
- features: List of features
366361

367362
- Features to train on
368363

364+
- directory: String
365+
366+
- default: /home/user/.cache/dffml/scratch
367+
- Directory where state should be saved
368+
369369
dffml_model_scikit
370370
------------------
371371

docs/plugins/dffml_source.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ Uses a CSV file as the source of repo feature data
2828

2929
- filename: String
3030

31-
- readonly: Boolean
32-
33-
- default: False
34-
3531
- label: String
3632

3733
- default: unlabeled
3834

39-
- labelcol: String
35+
- readonly: Boolean
4036

41-
- default: label
37+
- default: False
4238

4339
- key: String
4440

4541
- default: src_url
4642

43+
- labelcol: String
44+
45+
- default: label
46+
4747
json
4848
~~~~
4949

@@ -56,14 +56,14 @@ stored in memory.
5656

5757
- filename: String
5858

59-
- readonly: Boolean
60-
61-
- default: False
62-
6359
- label: String
6460

6561
- default: unlabeled
6662

63+
- readonly: Boolean
64+
65+
- default: False
66+
6767
memory
6868
~~~~~~
6969

@@ -73,9 +73,7 @@ Stores repos in a dict in memory
7373

7474
**Args**
7575

76-
- keys: List of strings
77-
78-
- default: []
76+
- repos: List of repos
7977

8078
dffml_source_mysql
8179
------------------

0 commit comments

Comments
 (0)