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

Commit

Permalink
docs: Add base to API docs
Browse files Browse the repository at this point in the history
Signed-off-by: John Andersen <[email protected]>
  • Loading branch information
pdxjohnny committed Dec 12, 2019
1 parent ca96c32 commit dcd883d
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 50 deletions.
6 changes: 6 additions & 0 deletions docs/api/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Base
====

.. automodule:: dffml.base
:members:
:undoc-members:
1 change: 1 addition & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ API Reference
:maxdepth: 2
:caption: Contents:

base
df/index
feature
repo
Expand Down
74 changes: 37 additions & 37 deletions docs/plugins/dffml_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,22 @@ Implemented using Tensorflow's DNNClassifier.
**Args**

- directory: String
- classification: String

- default: /home/user/.cache/dffml/tensorflow
- Directory where state should be saved
- Feature name holding classification value

- classifications: List of strings

- Options for value of classification

- features: List of features

- Features to train on

- clstype: Type

- default: <class 'str'>
- Data type of classifications values

- steps: Integer

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

- directory: String

- default: /home/user/.cache/dffml/tensorflow
- Directory where state should be saved

- hidden: List of integers

- default: [12, 40, 15]
- 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

- classification: String

- Feature name holding classification value

- classifications: List of strings

- Options for value of classification

- clstype: locate

- default: <class 'str'>
- Data type of classifications values (default: str)

- features: List of feature.loads

- Features to train on

tfdnnr
~~~~~~

Expand Down Expand Up @@ -254,10 +254,13 @@ predict).

**Args**

- directory: String
- predict: String

- default: /home/user/.cache/dffml/tensorflow
- Directory where state should be saved
- Feature name holding target values

- features: List of features

- Features to train on

- steps: Integer

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

- directory: String

- default: /home/user/.cache/dffml/tensorflow
- Directory where state should be saved

- hidden: List of integers

- default: [12, 40, 15]
- 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

- predict: String

- Feature name holding truth value

- features: List of feature.loads

- Features to train on

dffml_model_scratch
-------------------

Expand Down Expand Up @@ -353,19 +353,19 @@ hash of their feature names.
**Args**

- directory: String

- default: /home/user/.cache/dffml/scratch
- Directory where state should be saved

- predict: String

- Label or the value to be predicted

- features: List of feature.loads
- features: List of features

- Features to train on

- directory: String

- default: /home/user/.cache/dffml/scratch
- Directory where state should be saved

dffml_model_scikit
------------------

Expand Down
24 changes: 11 additions & 13 deletions docs/plugins/dffml_source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ Uses a CSV file as the source of repo feature data

- filename: String

- readonly: Boolean

- default: False

- label: String

- default: unlabeled

- labelcol: String
- readonly: Boolean

- default: label
- default: False

- key: String

- default: src_url

- labelcol: String

- default: label

json
~~~~

Expand All @@ -56,14 +56,14 @@ stored in memory.

- filename: String

- readonly: Boolean

- default: False

- label: String

- default: unlabeled

- readonly: Boolean

- default: False

memory
~~~~~~

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

**Args**

- keys: List of strings

- default: []
- repos: List of repos

dffml_source_mysql
------------------
Expand Down

0 comments on commit dcd883d

Please sign in to comment.