Improve docs

This commit is contained in:
Andras Schmelczer 2022-07-10 19:43:39 +02:00
parent c974409fce
commit b97b20ba88
No known key found for this signature in database
GPG key ID: 0EA1BC97D0AB076E
14 changed files with 303 additions and 33 deletions

56
docs/reference/index.md Normal file
View file

@ -0,0 +1,56 @@
# Reference
```python
from great_ai import *
```
## Core
::: great_ai.GreatAI
options:
filters: ['!__init__']
show_root_heading: true
::: great_ai.configure
options:
show_root_heading: true
::: great_ai.save_model
options:
show_root_heading: true
::: great_ai.use_model
options:
show_root_heading: true
::: great_ai.parameter
options:
show_root_heading: true
::: great_ai.log_metric
options:
show_root_heading: true
## Remote calls
::: great_ai.call_remote_great_ai
options:
show_root_heading: true
::: great_ai.call_remote_great_ai_async
options:
show_root_heading: true
## Ground-truth
::: great_ai.add_ground_truth
options:
show_root_heading: true
::: great_ai.query_ground_truth
options:
show_root_heading: true
::: great_ai.delete_ground_truth
options:
show_root_heading: true