From dcd883d3d6a690e2175b8a1cb10fe4185a0fad6a Mon Sep 17 00:00:00 2001 From: John Andersen Date: Thu, 12 Dec 2019 00:13:15 -0800 Subject: [PATCH] docs: Add base to API docs Signed-off-by: John Andersen --- docs/api/base.rst | 6 +++ docs/api/index.rst | 1 + docs/plugins/dffml_model.rst | 74 +++++++++++++++++------------------ docs/plugins/dffml_source.rst | 24 ++++++------ 4 files changed, 55 insertions(+), 50 deletions(-) create mode 100644 docs/api/base.rst diff --git a/docs/api/base.rst b/docs/api/base.rst new file mode 100644 index 0000000000..4580117c6b --- /dev/null +++ b/docs/api/base.rst @@ -0,0 +1,6 @@ +Base +==== + +.. automodule:: dffml.base + :members: + :undoc-members: diff --git a/docs/api/index.rst b/docs/api/index.rst index 2c617b4542..29ccb4495c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -6,6 +6,7 @@ API Reference :maxdepth: 2 :caption: Contents: + base df/index feature repo diff --git a/docs/plugins/dffml_model.rst b/docs/plugins/dffml_model.rst index 1bc2aaabb6..5bbc754886 100644 --- a/docs/plugins/dffml_model.rst +++ b/docs/plugins/dffml_model.rst @@ -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: + - Data type of classifications values - steps: Integer @@ -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: - - Data type of classifications values (default: str) - -- features: List of feature.loads - - - Features to train on - tfdnnr ~~~~~~ @@ -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 @@ -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 ------------------- @@ -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 ------------------ diff --git a/docs/plugins/dffml_source.rst b/docs/plugins/dffml_source.rst index aba5826c77..7c770fd70c 100644 --- a/docs/plugins/dffml_source.rst +++ b/docs/plugins/dffml_source.rst @@ -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 ~~~~ @@ -56,14 +56,14 @@ stored in memory. - filename: String -- readonly: Boolean - - - default: False - - label: String - default: unlabeled +- readonly: Boolean + + - default: False + memory ~~~~~~ @@ -73,9 +73,7 @@ Stores repos in a dict in memory **Args** -- keys: List of strings - - - default: [] +- repos: List of repos dffml_source_mysql ------------------