chore: add pre-commit

Author: nglehuy

.gitignore

@@ -9,7 +9,8 @@ Session.vim
 .idea
 __pycache__
 .pytest*
-venv
+venv*
+.venv*
 my_train
 .DS_Store
 models/*

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: local
+    hooks:
+      - id: black-formatter-check
+        name: black-formatter-check
+        entry: black --check
+        language: system
+        types: [python]
+        stages: [pre-commit]
+        fail_fast: true
+        verbose: true
+      - id: pylint-check
+        name: pylint-check
+        entry: pylint --rcfile=.pylintrc -rn -sn
+        language: system
+        types: [python]
+        stages: [pre-commit]
+        fail_fast: true
+        require_serial: true
+        verbose: true

.pylintrc

@@ -580,6 +580,4 @@ min-public-methods=2
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when being caught. Defaults to
-# "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=

README.md

@@ -115,13 +115,21 @@ pip3 install -e ".[tf2.x]" # or ".[tf2.x-gpu]" or ".[tf2.x-apple]" for apple m1
 
 Due to tensorflow-text is not built for Apple Sillicon, we need to install it with the prebuilt wheel file from [sun1638650145/Libraries-and-Extensions-for-TensorFlow-for-Apple-Silicon](https://github.com/sun1638650145/Libraries-and-Extensions-for-TensorFlow-for-Apple-Silicon)
 
+```bash
+git clone https://github.com/TensorSpeech/TensorFlowASR.git
+cd TensorFlowASR
+pip3 install -e "." # or pip3 install -e ".[dev] for development # or pip3 install "TensorFlowASR[dev]" from PyPi
+pip3 install tensorflow~=2.14.0 # change minor version if you want
+```
+
 Do this after installing TensorFlowASR with tensorflow above
 
 ```bash
 TF_VERSION="$(python3 -c 'import tensorflow; print(tensorflow.__version__)')" && \
 TF_VERSION_MAJOR="$(echo $TF_VERSION | cut -d'.' -f1,2)" && \
+PY_VERSION="$(python3 -c 'import platform; major, minor, patch = platform.python_version_tuple(); print(f"{major}{minor}");')" && \
 URL="https://github.com/sun1638650145/Libraries-and-Extensions-for-TensorFlow-for-Apple-Silicon" && \
-pip3 install "${URL}/releases/download/v${TF_VERSION_MAJOR}/tensorflow_text-${TF_VERSION_MAJOR}.0-cp310-cp310-macosx_11_0_arm64.whl"
+pip3 install "${URL}/releases/download/v${TF_VERSION_MAJOR}/tensorflow_text-${TF_VERSION_MAJOR}.0-cp${PY_VERSION}-cp${PY_VERSION}-macosx_11_0_arm64.whl"
 ```
 
 ### Running in a container

requirements.txt

@@ -18,6 +18,7 @@ pylint~=3.1.0
 matplotlib~=3.7.2
 pydot~=1.4.2
 graphviz~=0.20.1
+pre-commit~=3.7.0
 
 # extra=tf2-12
 tensorflow~=2.12.0