display badges in github README

kurianbenoy · Mar 12, 2024 · 1a47770 · 1a47770
1 parent 8b78d83
commit 1a47770
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,27 @@
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
+> A python package for text standardisation/normalization. It uses
+> normalization algorithm mentioned in OpenAI whisper paper. Using
+> Whisper normalization can cause issues in Indic languages and other
+> low resource languages when using
+> [`BasicTextNormalizer`](https://kurianbenoy.github.io/whisper_normalizer/basic.html#basictextnormalizer).
+> So normalization in Indic languages is also implemented in this
+> package which was derived from
+> [indic-nlp-library](https://github.com/anoopkunchukuttan/indic_nlp_library).
+
+[![Github
+license](https://img.shields.io/github/license/kurianbenoy/whisper_normalizer.svg)](https://github.com/kurianbenoy/whisper_normalizer/blob/main/LICENSE)
+[![Github
+Stars](https://img.shields.io/github/stars/kurianbenoy/whisper_normalizer.svg?colorA=orange&colorB=orange&logo=github)](https://github.com/kurianbenoy/whisper_normalizer/stargazers)
+[![PyPI
+version](https://img.shields.io/pypi/v/whisper-normalizer.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/whisper-normalizer/)
+[![python
+version](https://img.shields.io/badge/Python-%3E=3.7-blue)](https://github.com/kurianbenoy/whisper_normalizer)
+[![python
+version](https://img.shields.io/badge/Python-%3C3.12-blue)](https://github.com/kurianbenoy/whisper_normalizer)
+[![Downloads](https://pepy.tech/badge/whisper-normalizer.png)](https://github.com/kurianbenoy/whisper_normalizer)
+
 This package is a python implementation of the text
 standardisation/normalization approach which is being used in OpenAI
 whisper. The code was originally being released as open-source in
@@ -99,4 +120,4 @@ normalizer = MalayalamNormalizer()
 normalizer("എന്റെ കമ്പ്യൂട്ടറിനു് എന്റെ ഭാഷ.")
 ```
 
-    'എന്റെ കമ്പ്യൂട്ടറിനു് എന്റെ ഭാഷ.'
+    'എന്റെ കമ്പ്യൂട്ടറിന് എന്റെ ഭാഷ.'
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -4,13 +4,21 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# whisper_normalizer\n",
+    "# whisper_normalizer"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> A python package for text standardisation/normalization. It uses normalization algorithm mentioned in OpenAI whisper paper. Using Whisper normalization can cause issues in Indic languages and other low resource languages when using `BasicTextNormalizer`. So normalization in Indic languages is also implemented in this package which was derived from [indic-nlp-library](https://github.com/anoopkunchukuttan/indic_nlp_library).\n",
     "\n",
-    "> A python package for text standardisation/normalization approach which is being used in OpenAI whisper.\n",
     "\n",
+    "[![Github license](https://img.shields.io/github/license/kurianbenoy/whisper_normalizer.svg)](https://github.com/kurianbenoy/whisper_normalizer/blob/main/LICENSE)\n",
+    "[![Github Stars](https://img.shields.io/github/stars/kurianbenoy/whisper_normalizer.svg?colorA=orange&colorB=orange&logo=github)](https://github.com/kurianbenoy/whisper_normalizer/stargazers)\n",
     "[![PyPI version](https://img.shields.io/pypi/v/whisper-normalizer.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/whisper-normalizer/)\n",
-    "[![python version](https://img.shields.io/badge/Python-%3E=3.7-blue)](https://github.com/OpenNyAI/Opennyai)\n",
-    "[![python version](https://img.shields.io/badge/Python-<3.12-blue)](https://github.com/OpenNyAI/Opennyai)\n",
+    "[![python version](https://img.shields.io/badge/Python-%3E=3.7-blue)](https://github.com/kurianbenoy/whisper_normalizer)\n",
+    "[![python version](https://img.shields.io/badge/Python-<3.12-blue)](https://github.com/kurianbenoy/whisper_normalizer)\n",
     "[![Downloads](https://pepy.tech/badge/whisper-normalizer)](https://github.com/kurianbenoy/whisper_normalizer)"
    ]
   },
@@ -147,7 +155,7 @@
     {
      "data": {
       "text/plain": [
-       "'എന്റെ കമ്പ്യൂട്ടറിനു് എന്റെ ഭാഷ.'"
+       "'എന്റെ കമ്പ്യൂട്ടറിന് എന്റെ ഭാഷ.'"
       ]
      },
      "execution_count": null,