diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index fcb69e44..d3952c14 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,9 +1,7 @@ -## 내용 +### Problem Definition -ISSUE의 내용을 적어주세요. +CONTENTS -## 작업 내용 +### To Do - [ ] Todo 1 - -## 참고 사항 \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f8c8da5f..fb5e8c74 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,9 @@ -## 작업 내용 +### Features -resolves: #{이슈번호} ++ SUBMODULE_NAME + + FEAT: CONTENTS (resolves: #ISSUE_NUMBER) +... -## 참고 사항 +### Docs -PR을 리뷰할 때 중점적으로 리뷰가 필요하거나 참고가 필요한 내용을 적어주세요. \ No newline at end of file +### Chore diff --git a/Jenkinsfile b/Jenkinsfile index 7437eaa0..17ff49a9 100644 --- a/Jenkinsfile +++ b/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" diff --git a/docs/.buildinfo b/docs/.buildinfo index db82b61d..d2cef0ee 100644 --- a/docs/.buildinfo +++ b/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 diff --git a/docs/_sources/release.md.txt b/docs/_sources/release.md.txt index 78610bbc..2538c8cb 100644 --- a/docs/_sources/release.md.txt +++ b/docs/_sources/release.md.txt @@ -1,3 +1,22 @@ # Release Notes -[To be continued...](https://github.com/Zerohertz/zerohertzLib/issues/62) \ No newline at end of file +```{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 +``` diff --git a/docs/_sources/release/v0.1.1.md.txt b/docs/_sources/release/v0.1.1.md.txt new file mode 100644 index 00000000..de965f48 --- /dev/null +++ b/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 +``` + +
+ + +### 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 +``` + + + + +### Chore + ++ Jenkins에서 Sphinx build 후 변경사항이 존재하지 않는 것에 대한 예외 처리 ++ Legacy code 수정 diff --git a/docs/_sources/release/v0.1.10.md.txt b/docs/_sources/release/v0.1.10.md.txt new file mode 100644 index 00000000..fc3675d6 --- /dev/null +++ b/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 +``` + + + + +### 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)) \ No newline at end of file diff --git a/docs/_sources/release/v0.1.2.md.txt b/docs/_sources/release/v0.1.2.md.txt new file mode 100644 index 00000000..e7e0d3de --- /dev/null +++ b/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 +``` + + + + +### 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 +``` + + + + +### Docs + ++ `__init__.py`의 버전 수동 업데이트 diff --git a/docs/_sources/release/v0.1.3.md.txt b/docs/_sources/release/v0.1.3.md.txt new file mode 100644 index 00000000..5131d4e7 --- /dev/null +++ b/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 +``` + + + + +### Features + ++ `algorithm` + + `dfs`, `bfs`의 구조 수정 + + `SoE` 함수 추가 + +### Docs + ++ GitHub `README.md` update + +### Chore + ++ `commitMessage`를 정의하는 파이프라인 추가 ([#10](https://github.com/Zerohertz/zerohertzLib/issues/10)) diff --git a/docs/_sources/release/v0.1.4.md.txt b/docs/_sources/release/v0.1.4.md.txt new file mode 100644 index 00000000..73e11804 --- /dev/null +++ b/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 +``` + + + + +### 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 +``` + + + + +### Docs + ++ Issue & PR template 추가 + +### Chore + ++ Sphinx 문서 build 시 branch 이름을 parsing하여 변경하도록 update (resolves: [#15](https://github.com/Zerohertz/zerohertzLib/issues/15)) \ No newline at end of file diff --git a/docs/_sources/release/v0.1.5.md.txt b/docs/_sources/release/v0.1.5.md.txt new file mode 100644 index 00000000..e88c41e5 --- /dev/null +++ b/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 +``` + + + + +### Features + ++ `plot` + + 규격화된 데이터의 시각화를 위한 `bar`, `hist`, `plot` 함수 개발 + +### Chore + ++ `setuptools.setuptools` URL 추가 diff --git a/docs/_sources/release/v0.1.6.md.txt b/docs/_sources/release/v0.1.6.md.txt new file mode 100644 index 00000000..94ecd533 --- /dev/null +++ b/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 +``` + + + + +### 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) 추가 diff --git a/docs/_sources/release/v0.1.7.md.txt b/docs/_sources/release/v0.1.7.md.txt new file mode 100644 index 00000000..4e3861d9 --- /dev/null +++ b/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 +``` + + + + +### 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` 의존성 명시 diff --git a/docs/_sources/release/v0.1.8.md.txt b/docs/_sources/release/v0.1.8.md.txt new file mode 100644 index 00000000..417347a4 --- /dev/null +++ b/docs/_sources/release/v0.1.8.md.txt @@ -0,0 +1,27 @@ +# v0.1.8 + +## [v0.1.8] Release ([#32](https://github.com/Zerohertz/zerohertzLib/pull/32)) + +```{admonition} Release Date +:class: tip + +2023/11/12 +``` + + + + +### Features + ++ `logging` + + `Logger`의 출력 양식 변경 + + `Logger`가 Discord Webhook을 이용할 수 있게 수정 + +### Docs + ++ 기타 sphinx 문서의 오타, 양식 수정 diff --git a/docs/_sources/release/v0.1.9.md.txt b/docs/_sources/release/v0.1.9.md.txt new file mode 100644 index 00000000..657726ca --- /dev/null +++ b/docs/_sources/release/v0.1.9.md.txt @@ -0,0 +1,40 @@ +# v0.1.9 + +## [v0.1.9] Release ([#35](https://github.com/Zerohertz/zerohertzLib/pull/35)) + +```{admonition} Release Date +:class: tip + +2023/11/13 +``` + + + + +### Features + ++ `algorithm` + + Fast Fourier Transform (FFT)를 수행하는 `fft` 함수 개발 ++ `mlops` + + Submodule 이름 변경 (`MLOps` → `mlops`) ++ `monitoring` + + 입력 경로의 용량을 pie chart로 시각화하는 `storage` 함수 추가 ++ `plot` + + Pie chart로 시각화하는 `pie` 함수 추가 + +### Docs + ++ Sphinx docs 내 Examples format 수정 + +### Chore + ++ Jenkins의 trigger 수정 (resolves: [#34](https://github.com/Zerohertz/zerohertzLib/issues/34)) diff --git a/docs/_sources/release/v0.2.0.md.txt b/docs/_sources/release/v0.2.0.md.txt new file mode 100644 index 00000000..90ac00fe --- /dev/null +++ b/docs/_sources/release/v0.2.0.md.txt @@ -0,0 +1,20 @@ +# v0.2.0 + +## [v0.2.0] Chore Update ([#46](https://github.com/Zerohertz/zerohertzLib/pull/46)) + +```{admonition} Release Date +:class: tip + +2023/11/14 +``` + + + + +### Chore + ++ GitHub Actions 기능 추가 (resolves: [#45](https://github.com/Zerohertz/zerohertzLib/issues/45)) diff --git a/docs/_sources/release/v0.2.1.md.txt b/docs/_sources/release/v0.2.1.md.txt new file mode 100644 index 00000000..0ccc0562 --- /dev/null +++ b/docs/_sources/release/v0.2.1.md.txt @@ -0,0 +1,47 @@ +# v0.2.1 + +## [v0.2.1] Release ([#56](https://github.com/Zerohertz/zerohertzLib/pull/56)) + +```{admonition} Release Date +:class: tip + +2023/11/15 +``` + + + + +### Features + ++ `api` + + `Discord` 객체화 + + 이미지 전송 메서드 개발 (resolves: [#50](https://github.com/Zerohertz/zerohertzLib/issues/50)) ++ `logging` + + `Discord` 객체 적용 ++ `vision` + + 이미지 시각화 함수 `bbox`, `masks`, `text` 개발 (resolves: [#49](https://github.com/Zerohertz/zerohertzLib/issues/49)) + + Bbox에 대한 전환 함수 개발 (`xyxy2xywh`, `xywh2xyxy`) + +### Docs + ++ `numpy`에 대한 더 상세한 type hint 작성 (resolves: [#53](https://github.com/Zerohertz/zerohertzLib/issues/53)) ++ Type hint 검수 (resolves: [#54](https://github.com/Zerohertz/zerohertzLib/issues/54)) ++ 문서 내 난잡한 type hint 제거 + +### Chore + ++ Test image의 resolution 감소 ++ PIL 의존성 해결 (resolves: [#57](https://github.com/Zerohertz/zerohertzLib/issues/57)) + +### Style + ++ `mlops` submodule 내 객체의 camel case 수정 + diff --git a/docs/_sources/release/v0.2.2.md.txt b/docs/_sources/release/v0.2.2.md.txt new file mode 100644 index 00000000..0b4ec842 --- /dev/null +++ b/docs/_sources/release/v0.2.2.md.txt @@ -0,0 +1,48 @@ +# v0.2.2 + +## [v0.2.2] Docs Update ([#59](https://github.com/Zerohertz/zerohertzLib/pull/59)) + +```{admonition} Release Date +:class: tip + +2023/11/15 +``` + + + + +### Chore + ++ Sphinx theme 변경에 따른 CI 의존성 수정 + +### Docs + ++ Sphinx theme 변경 ++ 문서 refactoring +## [v0.2.2] Docs Update ([#63](https://github.com/Zerohertz/zerohertzLib/pull/63)) + +```{admonition} Release Date +:class: tip + +2023/11/16 +``` + + + + +### Docs + ++ `.rst` → `.md` refactoring + +### Chore + ++ Jenkins: `docs-*` → `master` 빌드 추가 (resolves: [#61](https://github.com/Zerohertz/zerohertzLib/issues/61)) ++ GitHub Actions: `docs-*` → `master`에 대한 PR Label 코드 추가 diff --git a/docs/_sources/release/v0.2.3.md.txt b/docs/_sources/release/v0.2.3.md.txt new file mode 100644 index 00000000..d6443eaf --- /dev/null +++ b/docs/_sources/release/v0.2.3.md.txt @@ -0,0 +1,31 @@ +# v0.2.3 + +## [v0.2.3] Release ([#65](https://github.com/Zerohertz/zerohertzLib/pull/65)) + +```{admonition} Release Date +:class: tip + +2023/11/16 +``` + + + + +### Features + ++ `api` + + GitHub API 활용을 위한 `GitHub` 객체 개발 (resolves: [#62](https://github.com/Zerohertz/zerohertzLib/issues/62)) + + Release note의 문서화를 위한 메서드 개발 + +### Docs + ++ Sphinx 문서화를 위한 Issue 및 PR template 변경 + +### Chore + ++ GitHub API를 통한 Release Note 자동 생성 \ No newline at end of file diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 4774f7f9..ae7cd712 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'v0.2.2', + VERSION: 'v0.2.3', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/cicd.html b/docs/cicd.html index f52e81c7..cbe301a1 100644 --- a/docs/cicd.html +++ b/docs/cicd.html @@ -16,11 +16,11 @@ - + -