[docs] Add naming conventions for upload models to hf hub (#921)

- fix one line in datasets docu - adds naming conventions to sharing models docu
mindee · May 20, 2022 · 1ab6fe1 · 1ab6fe1
1 parent d802630
commit 1ab6fe1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/docs/source/using_doctr/sharing_models.rst b/docs/source/using_doctr/sharing_models.rst
@@ -81,13 +81,25 @@ It is also possible to push your model directly after training.
 
 
 Pretrained community models
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This section is to provide some tables for pretrained community models.
 Feel free to open a pull request or issue to add your model to this list.
 
+Naming conventions
+------------------
+
+We suggest using the following naming conventions for your models:
+
+**Classification:** ``doctr-<architecture>-<vocab>``
+
+**Detection:** ``doctr-<architecture>``
+
+**Recognition:** ``doctr-<architecture>-<vocab>``
+
+
 Classification
-^^^^^^^^^^^^^^
+--------------
 
 +---------------------------------+-------------------------------------+-----------------------+------------------------+
 |        **Architecture**         |            **Repo_ID**              |     **Vocabulary**    |     **Framework**      |
@@ -99,7 +111,7 @@ Classification
 
 
 Detection
-^^^^^^^^^
+---------
 
 +---------------------------------+-------------------------------------------------+------------------------+
 |        **Architecture**         |            **Repo_ID**                          |     **Framework**      |
@@ -111,7 +123,7 @@ Detection
 
 
 Recognition
-^^^^^^^^^^^
+-----------
 
 +---------------------------------+---------------------------------------------------+---------------------+------------------------+
 |        **Architecture**         |            **Repo_ID**                            |     **Language**    |     **Framework**      |

diff --git a/docs/source/using_doctr/using_datasets.rst b/docs/source/using_doctr/using_datasets.rst
@@ -70,7 +70,7 @@ This datasets contains the information to train or validate a text recognition m
 +-----------------------------+---------------------------------+---------------------------------+---------------------------------------------+
 | SVT                         | 257                             | 647                             | english / only uppercase labels             |
 +-----------------------------+---------------------------------+---------------------------------+---------------------------------------------+
-| SVHN                        | 73257                           | 26032                           | english                                     |
+| SVHN                        | 73257                           | 26032                           | digits                                      |
 +-----------------------------+---------------------------------+---------------------------------+---------------------------------------------+
 | SynthText                   | ~7100000                        | 707470                          | english                                     |
 +-----------------------------+---------------------------------+---------------------------------+---------------------------------------------+