Cloud-CV / Cloud-CV/Fabrik

[docs] Documentation headings unclear

Open
#521 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1.1k
Forks
237
PR merge metrics
No merged PRs in 30d

Description

#### Scenario:
- Documentation headings are confusing:
- [Basics of Using the Exported Keras Model](https://fabrik.readthedocs.io/en/latest/keras_json_usage_1.html) and [Use exported model in Keras](https://fabrik.readthedocs.io/en/latest/keras_json_usage_2.html)
- [Using an Exported Caffe Model](https://fabrik.readthedocs.io/en/latest/caffe_prototxt_usage_1.html) and [Use exported model in Caffe](https://fabrik.readthedocs.io/en/latest/caffe_prototxt_usage_2.html)
- Also, in [Using an Exported Caffe Model](https://fabrik.readthedocs.io/en/latest/caffe_prototxt_usage_1.html), the numbering of the text after the example looks to be wrong. (`Execute the following using ...`)

#### Expected:
- Names can be more clear. Like the "Basics of Using the Exported Keras Model" can be renamed as "Loading an exported Keras model" and similarly for Caffe.
- Numbering can be fixed.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.