Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Fix missing link in document #1187

Merged
merged 2 commits into from
Aug 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/specification/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ Config yaml file has following Unstandard YAML [pyyaml](https://pyyaml.org/) def
|`!!python/object:`|module.cls|module.cls instance|

You should remove these tags before using without python (pyyaml).
i.e. [classification.yaml](/blueoil/configs/example/classification.yaml)
i.e. [classification.yaml](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification.yaml)

# Meta yaml
The meta yaml file is created from config python file, that is only include `export` column parameter.
For application, the exported meta yaml file has following standard yaml, it means it is not include `!!python...` generated by pyyaml.

i.e. [classification_meta.yaml](/blueoil/configs/example/classification_meta.yaml)
i.e. [classification_meta.yaml](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification_meta.yaml)
4 changes: 2 additions & 2 deletions docs/usage/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ In the case with `images` option, create each layer output value npy files in `e

* Load config file from saved experiment dir.
* Export config file to yaml. See also [Config specification](../specification/config.md).
* `config.yaml` can be used for training and evaluation in python. i.e. [classification.yaml](../../blueoil/configs/example/classification.yaml) is exported from [classification.py](../../blueoil/configs/example/classification.py)
* `meta.yaml` include only few parameter for application such as demo. i.e. [classification_meta.yaml](../../blueoil/configs/example/classification_meta.yaml) is exported from [classification.py](../../blueoil/configs/example/classification.py)
* `config.yaml` can be used for training and evaluation in python. i.e. [classification.yaml](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification.yaml) is exported from [classification.py](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification.py)
* `meta.yaml` include only few parameter for application such as demo. i.e. [classification_meta.yaml](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification_meta.yaml) is exported from [classification.py](https://github.com/blue-oil/blueoil/blob/master/blueoil/configs/example/classification.py)
* Save the model protocol buffer files (tf) for DLK converter.
* Output each layer npy files for DLK converter debug.
* Write summary in tensorboard `export` dir.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ common:
- probability: 0.5
```

Please see <a href="../reference/data_augmentor.html">the data augmentor reference page</a>, when you want to know about augmentation methods. All of the augmentation methods and the required parameters are explained there. Method names in the generated yaml file correspond to class names under `blueoil.data_augmentor` in the reference.
Please see <a href="../autoapi/blueoil/data_augmentor/index.html">the data augmentor reference page</a>, when you want to know about augmentation methods. All of the augmentation methods and the required parameters are explained there. Method names in the generated yaml file correspond to class names under `blueoil.data_augmentor` in the reference.


#### optimizer
Expand Down