From 1ab6fe1cc767b0f5a451c128761849a2db30582f Mon Sep 17 00:00:00 2001 From: Felix Dittrich Date: Fri, 20 May 2022 15:43:37 +0200 Subject: [PATCH] [docs] Add naming conventions for upload models to hf hub (#921) - fix one line in datasets docu - adds naming conventions to sharing models docu --- docs/source/using_doctr/sharing_models.rst | 20 ++++++++++++++++---- docs/source/using_doctr/using_datasets.rst | 2 +- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/source/using_doctr/sharing_models.rst b/docs/source/using_doctr/sharing_models.rst index 72abae248f..572bbca780 100644 --- 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--`` + +**Detection:** ``doctr-`` + +**Recognition:** ``doctr--`` + + 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 index 18a36bf450..f3f149e59b 100644 --- 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 | +-----------------------------+---------------------------------+---------------------------------+---------------------------------------------+