Skip to content

Commit

Permalink
Add am.Model to doc.
Browse files Browse the repository at this point in the history
Signed-off-by: xAsiimov <admin@xasiimov.com>
  • Loading branch information
xAsiimov committed Jun 17, 2019
1 parent e9662ee commit ba73610
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 2 deletions.
67 changes: 66 additions & 1 deletion docs/python/am.md
Expand Up @@ -26,7 +26,7 @@ class CombinedPredictionData

class IntentNERData

class Model
[class Model](https://gundammc.github.io/animius/python/am#ammodel)

[class ModelConfig](https://gundammc.github.io/animius/python/am#ammodelconfig)

Expand Down Expand Up @@ -129,6 +129,71 @@ Returns:

The reference to a thread object which socket server is running on.

## am.Model

am.Model is an abstract class which is the template of other models.

Defined in [animius/Model.py](https://github.com/gundamMC/animius/blob/master/animius/Model.py).

### \_\_init\_\_

Args: None

### Properties

### Methods

#### DEFAULT_CONFIG

```am.Model.DEFAULT_CONFIG()```

Get defaul model config.

Args: None

Returns: A dict of model config.

#### DEFAULT_MODEL_STRUCTURE

```am.Model.DEFAULT_MODEL_STRUCTURE()```

Get defaul model structure of specific model.

Args: None

Returns: A dict of model structure.

#### DEFAULT_HYPERPARAMETERS

```am.Model.DEFAULT_HYPERPARAMETERS()```

Get defaul hyperparameters.

Args: None

Returns: A dict of hyperparameters.

#### build_graph

'build_graph' is a abstract method.

#### init_tensorflow

```init_tensorflow(graph=None, init_param=True, init_sess=True)```

Initialize TensorFlow.

Args:

* *graph* (```tf.Graph```) -- reference to a tf.Graph object. (Optional)

* *init_param** (```bool```) -- whether or not to initialize parameters. (Optional)

* *init_sess** (```bool```) -- whether or not to initialize tf.Session. (Optional)

Returns: None.


## am.ModelConfig

Defined in [animius/ModelConfig.py](https://github.com/gundamMC/animius/blob/master/animius/ModelConfig.py).
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Expand Up @@ -19,7 +19,7 @@ nav:
- am.Chatbot: 'python/am.Chatbot.md'
- am.IntentNER: 'python/am.IntentNER.md'
- am.SpeakerVerification: 'python/am.SpeakerVerification.md'
- am.Util: 'python/am.Util.md'
- am.Utils: 'python/am.Utils.md'
- Commands:
- Overview: 'commands/overview.md'
- Waifu: 'commands/waifu.md'
Expand Down

0 comments on commit ba73610

Please sign in to comment.