Merge pull request #65 from Zerohertz/dev-v0.2.3

[v0.2.3] Release

.github/ISSUE_TEMPLATE.md

@@ -1,9 +1,7 @@
-## 내용
+### Problem Definition
 
-ISSUE의 내용을 적어주세요.
+CONTENTS
 
-## 작업 내용
+### To Do
 
 - [ ] Todo 1
-
-## 참고 사항

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,9 @@
-## 작업 내용
+### Features
 
-resolves: #{이슈번호}
++ SUBMODULE_NAME
+  + FEAT: CONTENTS (resolves: #ISSUE_NUMBER)
+...
 
-## 참고 사항
+### Docs
 
-PR을 리뷰할 때 중점적으로 리뷰가 필요하거나 참고가 필요한 내용을 적어주세요.
+### Chore

Jenkinsfile

@@ -227,6 +227,7 @@ spec:
                                 sh "apt update"
                                 sh "apt install build-essential -y"
                                 sh "pip install sphinx furo sphinxcontrib-jquery sphinxcontrib-gtagjs sphinx-favicon sphinx-copybutton sphinx-paramlinks myst-parser"
+                                sh 'python sphinx/release_note.py --token $GIT_PASSWORD'
                                 sh "cd sphinx && make html"
                                 sh "rm -rf docs"
                                 sh "mv sphinx/build/html docs"

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6f6395cbe750af901a820c532a7b36ba
+config: f63872d16d44644ace77db2b399ac41d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/release.md.txt

@@ -1,3 +1,22 @@
 # Release Notes
 
-[To be continued...](https://github.com/Zerohertz/zerohertzLib/issues/62)
+```{eval-rst}
+.. toctree::
+	:maxdepth: 2
+	:caption: Contents:
+
+	release/v0.2.3
+	release/v0.2.2
+	release/v0.2.1
+	release/v0.2.0
+	release/v0.1.10
+	release/v0.1.9
+	release/v0.1.8
+	release/v0.1.7
+	release/v0.1.6
+	release/v0.1.5
+	release/v0.1.4
+	release/v0.1.3
+	release/v0.1.2
+	release/v0.1.1
+```

docs/_sources/release/v0.1.1.md.txt

@@ -0,0 +1,50 @@
+# v0.1.1
+
+## [v0.1.1] Release ([#1](https://github.com/Zerohertz/zerohertzLib/pull/1))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/algorithm"><img src="https://img.shields.io/badge/feat/algorithm-0759DE?style=flat-square&logo=github" alt="feat/algorithm"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `algorithm`
+  + `bfs`, `dfs` 개발
+
+### Docs
+
++ Sphinx 초기 설정
+
+### Chore
+
++ Sphinx build pipeline 구축
+## [v0.1.1] Chore Update ([#6](https://github.com/Zerohertz/zerohertzLib/pull/6))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Chore
+
++ Jenkins에서 Sphinx build 후 변경사항이 존재하지 않는 것에 대한 예외 처리
++ Legacy code 수정

docs/_sources/release/v0.1.10.md.txt

@@ -0,0 +1,33 @@
+# v0.1.10
+
+## [v0.1.10] Release ([#42](https://github.com/Zerohertz/zerohertzLib/pull/42))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/14
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/plot"><img src="https://img.shields.io/badge/feat/plot-968B14?style=flat-square&logo=github" alt="feat/plot"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/vision"><img src="https://img.shields.io/badge/feat/vision-D1F9CB?style=flat-square&logo=github" alt="feat/vision"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `plot`
+   + Scatter chart 시각화 함수 `scatter` 추가
+   + Pie chart의 label에 소수 자리가 생기는 문제 해결 (resolves: [#40](https://github.com/Zerohertz/zerohertzLib/issues/40))
++ `vision`
+  + `cv2` 의존성이 설치되지 않은 경우에도 사용할 수 있도록 변경
+  + 이미지의 전후 비교를 위한 `before_after` 함수 개발
+  + 여러 이미지를 한번에 요약해 볼 수 있는 `grid` 함수 개발 (resolves: [#39](https://github.com/Zerohertz/zerohertzLib/issues/39))
+
+### Chore
+
++ Issue 및 PR의 태그 생성 추가 (resolves: [#41](https://github.com/Zerohertz/zerohertzLib/issues/41))

docs/_sources/release/v0.1.2.md.txt

@@ -0,0 +1,38 @@
+# v0.1.2
+
+## [v0.1.2] Chore Update ([#7](https://github.com/Zerohertz/zerohertzLib/pull/7))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Chore
+
++ [Insecure한 pipeline](https://www.jenkins.io/doc/book/pipeline/jenkinsfile//#string-interpolation) 수정
+## [v0.1.2] Docs Update ([#8](https://github.com/Zerohertz/zerohertzLib/pull/8))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Docs
+
++ `__init__.py`의 버전 수동 업데이트

docs/_sources/release/v0.1.3.md.txt

@@ -0,0 +1,32 @@
+# v0.1.3
+
+## [v0.1.3] Release ([#11](https://github.com/Zerohertz/zerohertzLib/pull/11))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/05
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/algorithm"><img src="https://img.shields.io/badge/feat/algorithm-0759DE?style=flat-square&logo=github" alt="feat/algorithm"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `algorithm`
+  + `dfs`, `bfs`의 구조 수정
+  + `SoE` 함수 추가
+
+### Docs
+
++ GitHub `README.md` update
+
+### Chore
+
++ `commitMessage`를 정의하는 파이프라인 추가 ([#10](https://github.com/Zerohertz/zerohertzLib/issues/10))

docs/_sources/release/v0.1.4.md.txt

@@ -0,0 +1,55 @@
+# v0.1.4
+
+## [v0.1.4] Release ([#13](https://github.com/Zerohertz/zerohertzLib/pull/13))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/06
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/algorithm"><img src="https://img.shields.io/badge/feat/algorithm-0759DE?style=flat-square&logo=github" alt="feat/algorithm"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/api"><img src="https://img.shields.io/badge/feat/api-541B9A?style=flat-square&logo=github" alt="feat/api"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:style"><img src="https://img.shields.io/badge/style-03A17F?style=flat-square&logo=github" alt="style"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `algorithm`
+  + `import` style refactoring
++ `api`
+  + OpenAI의 GPT-3.5를 사용하기 위한 함수 `api_key`, `gpt` 추가
+  + Discord webhook에 메시지를 전송하는 `send_discord_message` 추가
+
+### Docs
+
++ Sphinx `index.rst`에 GitHub `README.md` 내용 추가
++ 기타 구조 수정
+## [v0.1.4] Chore Update ([#16](https://github.com/Zerohertz/zerohertzLib/pull/16))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/06
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:style"><img src="https://img.shields.io/badge/style-03A17F?style=flat-square&logo=github" alt="style"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Docs
+
++ Issue & PR template 추가
+
+### Chore
+
++ Sphinx 문서 build 시 branch 이름을 parsing하여 변경하도록 update (resolves: [#15](https://github.com/Zerohertz/zerohertzLib/issues/15))

docs/_sources/release/v0.1.5.md.txt

@@ -0,0 +1,27 @@
+# v0.1.5
+
+## [v0.1.5] Release ([#20](https://github.com/Zerohertz/zerohertzLib/pull/20))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/06
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/plot"><img src="https://img.shields.io/badge/feat/plot-968B14?style=flat-square&logo=github" alt="feat/plot"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `plot`
+  + 규격화된 데이터의 시각화를 위한 `bar`, `hist`, `plot` 함수 개발
+
+### Chore
+
++ `setuptools.setuptools` URL 추가

docs/_sources/release/v0.1.6.md.txt

@@ -0,0 +1,33 @@
+# v0.1.6
+
+## [v0.1.6] Release ([#23](https://github.com/Zerohertz/zerohertzLib/pull/23))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/06
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/plot"><img src="https://img.shields.io/badge/feat/plot-968B14?style=flat-square&logo=github" alt="feat/plot"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/vision"><img src="https://img.shields.io/badge/feat/vision-D1F9CB?style=flat-square&logo=github" alt="feat/vision"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:style"><img src="https://img.shields.io/badge/style-03A17F?style=flat-square&logo=github" alt="style"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `plot`
+  + test 코드 수정
+  + Horizontal bar chart 추가
++ `vision`
+  + GIF 변환을 위한 `img2gif`, `vid2gif` 함수 추가 (resolves: [#22](https://github.com/Zerohertz/zerohertzLib/issues/22) )
+
+### Chore
+
++ CI 과정에서 `cv2` 의존성 설치
++ [Codacy](https://app.codacy.com/gh/Zerohertz/zerohertzLib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) 추가

docs/_sources/release/v0.1.7.md.txt

@@ -0,0 +1,35 @@
+# v0.1.7
+
+## [v0.1.7] Release ([#26](https://github.com/Zerohertz/zerohertzLib/pull/26))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/07
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/api"><img src="https://img.shields.io/badge/feat/api-541B9A?style=flat-square&logo=github" alt="feat/api"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/logging"><img src="https://img.shields.io/badge/feat/logging-477A5E?style=flat-square&logo=github" alt="feat/logging"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/mlops"><img src="https://img.shields.io/badge/feat/mlops-EE5D2A?style=flat-square&logo=github" alt="feat/mlops"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+### Features
+
++ `api`
+  + `openai` 모듈의 업데이트로 의존성 에러 발생 (resolves: [#25](https://github.com/Zerohertz/zerohertzLib/issues/25))
++ `logging`
+  + `Logger` 추가
++ `mlops`
+  + Triton Inference Server의 Client를 손쉽게 사용할 수 있는 class `tritonClientURL`, `tritonClientK8s` 추가 
+  + 변수명 수정 (resolves: [#28](https://github.com/Zerohertz/zerohertzLib/issues/28))
+
+
+### Docs
+
++ Shphinx 영문 설정
++ `cv2` 의존성 명시