Merge branch '1.0.x' of https://github.com/ShemYu/learning-resource i…

README.md

@@ -15,10 +15,13 @@
 - [ ] Contents generator optimize and new feature
     - [ ] 依照筆記量釋出不同顏色標籤
       - [ ] 偵測筆記較少的 md 標記為`尚未完成
+      - 實作
+        - [X] 完成 Progressor 類別設計
     - [ ] 架構優化
     - [ ] Keyword 自動生成
     	- 從文本當中超連結自動爬入字串，以較為泛用的方式前處理並提取關鍵詞
   	- [ ] auto-gen module 建置於 pre-commit phase 自動執行產生目錄
+  	- [ ] 閱讀狀況數據統計報表
 
 ### Operations
 - [ ] 撰寫 CONTRIBUTING
@@ -48,64 +51,77 @@ $ pre-commit uninstall
 # Contents
 
 - reading
-	1. [vscode.md](https://github.com/ShemYu/learning-resource/blob/master//vscode.md)
+	1. [vscode.md](https://github.com/ShemYu/learning-resource/blob/read/reading/vscode.md)
 	- Data science
-		1. [Data science… without any data.md](https://github.com/ShemYu/learning-resource/blob/master/Data%20science/Data%20science%E2%80%A6%20without%20any%20data.md)
-		1. [資料科學五大 Q&A：如何成為資料科學家？資料科學產業的未來？.md](https://github.com/ShemYu/learning-resource/blob/master/Data%20science/%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E4%BA%94%E5%A4%A7%20Q%26A%EF%BC%9A%E5%A6%82%E4%BD%95%E6%88%90%E7%82%BA%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E5%AE%B6%EF%BC%9F%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E7%94%A2%E6%A5%AD%E7%9A%84%E6%9C%AA%E4%BE%86%EF%BC%9F.md)
+		1. [Data science… without any data.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Data%20science/Data%20science%E2%80%A6%20without%20any%20data.md)
+		1. [資料科學五大 Q&A：如何成為資料科學家？資料科學產業的未來？.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Data%20science/%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E4%BA%94%E5%A4%A7%20Q%26A%EF%BC%9A%E5%A6%82%E4%BD%95%E6%88%90%E7%82%BA%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E5%AE%B6%EF%BC%9F%E8%B3%87%E6%96%99%E7%A7%91%E5%AD%B8%E7%94%A2%E6%A5%AD%E7%9A%84%E6%9C%AA%E4%BE%86%EF%BC%9F.md)
 	- Data scientist roadmap
-		1. [Data scientist roadmap.md](https://github.com/ShemYu/learning-resource/blob/master/Data%20scientist%20roadmap/Data%20scientist%20roadmap.md)
+		1. [Data scientist roadmap.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Data%20scientist%20roadmap/Data%20scientist%20roadmap.md)
 	- Design Pattern
 
 		- Domain-Driven Design
-			1. [1_初探.md](https://github.com/ShemYu/learning-resource/blob/master/Design%20Pattern/Domain-Driven%20Design/1_%E5%88%9D%E6%8E%A2.md)
+			1. [1_初探.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Design%20Pattern/Domain-Driven%20Design/1_%E5%88%9D%E6%8E%A2.md)
 	- Docker
-		1. [3_Docker 基本運作.md](https://github.com/ShemYu/learning-resource/blob/master/Docker/3_Docker%20%E5%9F%BA%E6%9C%AC%E9%81%8B%E4%BD%9C.md)
-		1. [Docker compose.md](https://github.com/ShemYu/learning-resource/blob/master/Docker/Docker%20compose.md)
-		1. [Docker入門.md](https://github.com/ShemYu/learning-resource/blob/master/Docker/Docker%E5%85%A5%E9%96%80.md)
+		1. [3_Docker 基本運作.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Docker/3_Docker%20%E5%9F%BA%E6%9C%AC%E9%81%8B%E4%BD%9C.md)
+		1. [Docker compose.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Docker/Docker%20compose.md)
+		1. [Docker入門.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Docker/Docker%E5%85%A5%E9%96%80.md)
 	- Git
-		1. [CICD初探.md](https://github.com/ShemYu/learning-resource/blob/master/Git/CICD%E5%88%9D%E6%8E%A2.md)
-		1. [版本號的基本常識.md](https://github.com/ShemYu/learning-resource/blob/master/Git/%E7%89%88%E6%9C%AC%E8%99%9F%E7%9A%84%E5%9F%BA%E6%9C%AC%E5%B8%B8%E8%AD%98.md)
+		1. [CICD初探.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Git/CICD%E5%88%9D%E6%8E%A2.md)
+		1. [版本號的基本常識.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Git/%E7%89%88%E6%9C%AC%E8%99%9F%E7%9A%84%E5%9F%BA%E6%9C%AC%E5%B8%B8%E8%AD%98.md)
 		- Github pages
-			1. [Github pages - 輕鬆架設靜態網頁.md](https://github.com/ShemYu/learning-resource/blob/master/Git/Github%20pages/Github%20pages%20-%20%E8%BC%95%E9%AC%86%E6%9E%B6%E8%A8%AD%E9%9D%9C%E6%85%8B%E7%B6%B2%E9%A0%81.md)
+			1. [Github pages - 輕鬆架設靜態網頁.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Git/Github%20pages/Github%20pages%20-%20%E8%BC%95%E9%AC%86%E6%9E%B6%E8%A8%AD%E9%9D%9C%E6%85%8B%E7%B6%B2%E9%A0%81.md)
 	- Linux
-		1. [鳥哥 Shell script.md](https://github.com/ShemYu/learning-resource/blob/master/Linux/%E9%B3%A5%E5%93%A5%20Shell%20script.md)
+		1. [鳥哥 Shell script.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Linux/%E9%B3%A5%E5%93%A5%20Shell%20script.md)
 	- Programing
-		1. [Locust preformance testing tool.md](https://github.com/ShemYu/learning-resource/blob/master/Programing/Locust%20preformance%20testing%20tool.md)
-		1. [何謂DevOps.md](https://github.com/ShemYu/learning-resource/blob/master/Programing/%E4%BD%95%E8%AC%82DevOps.md)
+		1. [Locust preformance testing tool.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Programing/Locust%20preformance%20testing%20tool.md)
+		1. [何謂DevOps.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Programing/%E4%BD%95%E8%AC%82DevOps.md)
+		- 前端
+			1. [後端怎麼區分.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Programing/%E5%89%8D%E7%AB%AF/%E5%BE%8C%E7%AB%AF%E6%80%8E%E9%BA%BC%E5%8D%80%E5%88%86.md)
+			- img
+				1. [20210312181535.png](https://github.com/ShemYu/learning-resource/blob/read/reading/Programing/%E5%89%8D%E7%AB%AF/img/20210312181535.png)
 	- Python
-		1. [Anaconda.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Anaconda.md)
-		1. [Flask.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Flask.md)
-		1. [如何用 Python 撰寫 APP.md](https://github.com/ShemYu/learning-resource/blob/master/Python/%E5%A6%82%E4%BD%95%E7%94%A8%20Python%20%E6%92%B0%E5%AF%AB%20APP.md)
-		1. [如何處理比 memory 更大的資料.md](https://github.com/ShemYu/learning-resource/blob/master/Python/%E5%A6%82%E4%BD%95%E8%99%95%E7%90%86%E6%AF%94%20memory%20%E6%9B%B4%E5%A4%A7%E7%9A%84%E8%B3%87%E6%96%99.md)
-		1. [親自動手寫一個 Python libary.md](https://github.com/ShemYu/learning-resource/blob/master/Python/%E8%A6%AA%E8%87%AA%E5%8B%95%E6%89%8B%E5%AF%AB%E4%B8%80%E5%80%8B%20Python%20libary.md)
+		1. [Flask.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Flask.md)
+		1. [如何用 Python 撰寫 APP.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/%E5%A6%82%E4%BD%95%E7%94%A8%20Python%20%E6%92%B0%E5%AF%AB%20APP.md)
+		1. [如何處理比 memory 更大的資料.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/%E5%A6%82%E4%BD%95%E8%99%95%E7%90%86%E6%AF%94%20memory%20%E6%9B%B4%E5%A4%A7%E7%9A%84%E8%B3%87%E6%96%99.md)
+		1. [親自動手寫一個 Python libary.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/%E8%A6%AA%E8%87%AA%E5%8B%95%E6%89%8B%E5%AF%AB%E4%B8%80%E5%80%8B%20Python%20libary.md)
 		- Basic
-			1. [cmd `python` 預設使用 python3.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Basic/cmd%20%60python%60%20%E9%A0%90%E8%A8%AD%E4%BD%BF%E7%94%A8%20python3.md)
-			1. [Decorator.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Basic/Decorator.md)
-			1. [PIP.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Basic/PIP.md)
-			1. [Python 在 DevOps 中的應用.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Basic/Python%20%E5%9C%A8%20DevOps%20%E4%B8%AD%E7%9A%84%E6%87%89%E7%94%A8.md)
+			1. [.gitingore.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/.gitingore.md)
+			1. [Anaconda.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/Anaconda.md)
+			1. [Decorator.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/Decorator.md)
+			1. [Enum.ipynb](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/Enum.ipynb)
+			1. [PIP.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/PIP.md)
+			1. [Python 在 DevOps 中的應用.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/Python%20%E5%9C%A8%20DevOps%20%E4%B8%AD%E7%9A%84%E6%87%89%E7%94%A8.md)
+			1. [Python 當中的 switch case.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/Python%20%E7%95%B6%E4%B8%AD%E7%9A%84%20switch%20case.md)
+			1. [`python` command 預設使用 Python3.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/%60python%60%20command%20%E9%A0%90%E8%A8%AD%E4%BD%BF%E7%94%A8%20Python3.md)
+			1. [函式基本概念.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/%E5%87%BD%E5%BC%8F%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5.md)
+			1. [底線與命名規則.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Basic/%E5%BA%95%E7%B7%9A%E8%88%87%E5%91%BD%E5%90%8D%E8%A6%8F%E5%89%87.md)
 		- Class
-			1. [Meta class.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Class/Meta%20class.md)
-			1. [__new__ and __init__.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Class/__new__%20and%20__init__.md)
+			1. [Meta class.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Class/Meta%20class.md)
+			1. [__new__ and __init__.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Class/__new__%20and%20__init__.md)
+		- Error handling
+			1. [Professional Error Handling With Python.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Error%20handling/Professional%20Error%20Handling%20With%20Python.md)
 		- High quality code
-			1. [Code quality.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Code%20quality.md)
-			1. [Common practice of famous project.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Common%20practice%20of%20famous%20project.md)
-			1. [PEP8.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/PEP8.md)
+			1. [Code quality.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Code%20quality.md)
+			1. [Common practice of famous project.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Common%20practice%20of%20famous%20project.md)
+			1. [PEP8.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/PEP8.md)
 			- Coding style
-				1. [black.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/black.md)
-				1. [Coding style.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/Coding%20style.md)
-				1. [pylint.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/pylint.md)
+				1. [black.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/black.md)
+				1. [Coding style.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/Coding%20style.md)
+				1. [pylint.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/pylint.md)
 				- pre-commit
-					1. [1_調研 pre-commit.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/pre-commit/1_%E8%AA%BF%E7%A0%94%20pre-commit.md)
-					1. [2_pre-commit.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/pre-commit/2_pre-commit.md)
-					1. [3_pre-commit 三度調研.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Coding%20style/pre-commit/3_pre-commit%20%E4%B8%89%E5%BA%A6%E8%AA%BF%E7%A0%94.md)
+					1. [1_調研 pre-commit.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/pre-commit/1_%E8%AA%BF%E7%A0%94%20pre-commit.md)
+					1. [2_pre-commit.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/pre-commit/2_pre-commit.md)
+					1. [3_pre-commit 三度調研.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Coding%20style/pre-commit/3_pre-commit%20%E4%B8%89%E5%BA%A6%E8%AA%BF%E7%A0%94.md)
 			- Docs
-				1. [pydocstyle.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Docs/pydocstyle.md)
+				1. [pydocstyle.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Docs/pydocstyle.md)
 			- Testing
-				1. [Flaky test.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/Flaky%20test.md)
-				1. [Pytest Coverage.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/Pytest%20Coverage.md)
-				1. [Pytest doctest.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/Pytest%20doctest.md)
-				1. [Pytest notebook.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/Pytest%20notebook.md)
-				1. [Pytest 測試實戰.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/Pytest%20%E6%B8%AC%E8%A9%A6%E5%AF%A6%E6%88%B0.md)
-				1. [初探Tox.md](https://github.com/ShemYu/learning-resource/blob/master/Python/High%20quality%20code/Testing/%E5%88%9D%E6%8E%A2Tox.md)
+				1. [Flaky test.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/Flaky%20test.md)
+				1. [Pytest Coverage.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/Pytest%20Coverage.md)
+				1. [Pytest doctest.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/Pytest%20doctest.md)
+				1. [Pytest notebook.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/Pytest%20notebook.md)
+				1. [Pytest 測試實戰.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/Pytest%20%E6%B8%AC%E8%A9%A6%E5%AF%A6%E6%88%B0.md)
+				1. [初探Tox.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/High%20quality%20code/Testing/%E5%88%9D%E6%8E%A2Tox.md)
 		- Pyproject
-			1. [How to setup.py.md](https://github.com/ShemYu/learning-resource/blob/master/Python/Pyproject/How%20to%20setup.py.md)
+			1. [How to setup.py.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Pyproject/How%20to%20setup.py.md)
+		- Signals
+			1. [基本概念.md](https://github.com/ShemYu/learning-resource/blob/read/reading/Python/Signals/%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5.md)

autogencontents/base/base_class.py

@@ -51,10 +51,10 @@ def __init__(self, sec: Section, name):
         self.section = sec
         self.name = name
         # https://github.com/{OWNER_NAME}/{REPO_NAME}/blob/master/{PATH_TO_READING}/{READING_NAME}
-        self.url = "https://github.com/{}/{}/blob/master/{}/{}".format(
+        self.url = "https://github.com/{}/{}/blob/read/{}/{}".format(
             _OWNER_NAME,
             _REPO_NAME,
-            parse.quote("/".join(self.section.dirname_list[1:])),
+            parse.quote("/".join(self.section.dirname_list)),
             parse.quote(self.name),
         )
 

reading/API/Python API framework - FastAPI.md

@@ -0,0 +1,7 @@
+# FastAPI
+
+## 設定更多欄位相關資訊
+
+欄位相關的 `title`, `descriptions`, `validation` 資訊
+
+[ref.](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata)

reading/Data science/Model serving/初探.md

@@ -0,0 +1,20 @@
+# Model serving
+
+## What is serving 
+
+Serving is how you apply a ML model after you've training.
+
+Most common way is RPC server.
+
+### Goals of model serving
+
+- Online, low latency
+- Multiple model in a single process
+- Multiple version of a model laoded over time
+- Compute cost varies in real-time to meet product demand
+  - auto-scale with CloudML, Docker and K8S
+- Aim for the efficiency of mini-batching at training time ...
+  - except with requests arriving asynchronously
+
+## Reference 
+- [Machine Learning Model Serving Overview (Seldon Core, KFServing, BentoML, MLFlow)](https://medium.com/everything-full-stack/machine-learning-model-serving-overview-c01a6aa3e823)

reading/Git/.gitingore.md

@@ -0,0 +1,144 @@
+# Python .gitignore
+## 資源
+> ### [Github Python.gitignore](https://github.com/github/gitignore/blob/master/Python.gitignore)
+> Github 官方提供的基本配置，包含了所有 Python 常用的相關模塊，其中需被 ignore 的檔案配置
+```yml
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+```