refactor(project-description): update layout for better readability

chu-aie · Mar 3, 2024 · 7f22e80 · 7f22e80
1 parent d77ea4d
commit 7f22e80
Show file tree

Hide file tree

Showing 23 changed files with 2,087 additions and 136 deletions.
diff --git a/.copier-config.yaml b/.copier-config.yaml
@@ -23,7 +23,12 @@ package_scripts:
 poe_task_files:
 - .tasks.toml
 - .tasks-extra.toml
-project_description: 이 수업은 실제 운영 환경에서 기계 학습 시스템의 설계, 구현 및 관리에 대한 실질적인 측면을 다룹니다. 본 과정은 학생들에게 기계 학습 워크플로를 기존 소프트웨어 개발 및 운영 프로세스와 원활하게 통합하는 데 필요한 기술을 제공합니다. 이 과정에서는 DevOps, MLOps 및 보안 관행을 강조합니다. 학생들은 실습 프로젝트를 통해 dot 파일, git, Docker, Kubernetes, CI/CD 파이프라인, Weights & Biases 등 첨단 도구와 방법론을 사용하여 강력한 기계 학습 모델을 구축, 배포하고 유지 관리합니다. 또한, 이 과정은 학생들에게 GitOps, DevSecOps 및 LLMOps의 새로운 분야를 소개하여 실제 기계 학습 애플리케이션의 복잡성에 대비합니다.
+project_description: 이 수업은 실제 운영 환경에서 기계 학습 시스템의 설계, 구현 및 관리에 대한 실질적인 측면을 다룹니다. 본
+    과정은 학생들에게 기계 학습 워크플로를 기존 소프트웨어 개발 및 운영 프로세스와 원활하게 통합하는 데 필요한 기술을 제공합니다. 이 과정에서는
+    DevOps, MLOps 및 보안 관행을 강조합니다. 학생들은 실습 프로젝트를 통해 dot 파일, git, Docker, Kubernetes,
+    CI/CD 파이프라인, Weights & Biases 등 첨단 도구와 방법론을 사용하여 강력한 기계 학습 모델을 구축, 배포하고 유지 관리합니다.
+    또한, 이 과정은 학생들에게 GitOps, DevSecOps 및 LLMOps의 새로운 분야를 소개하여 실제 기계 학습 애플리케이션의 복잡성에
+    대비합니다.
 project_license: CC-BY-4.0
 project_name: mlops2024
 project_short_description: Machine Learning Systems Design

diff --git a/.copier-hyfi-config.yaml b/.copier-hyfi-config.yaml
@@ -0,0 +1,6 @@
+# Changes here will be overwritten by Copier; do NOT edit manually
+_commit: v0.6.10
+_src_path: gh:entelecheia/hyfi-template
+package_name: mlops2024
+project_name: mlops2024
+
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -14,6 +14,17 @@ updates:
     labels:
       - ":game_die: dependencies"
       - ":robot: bot"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "03:00"
+      timezone: "Asia/Seoul"
+    allow:
+      - dependency-type: "production"
+    labels:
+      - ":game_die: dependencies"
+      - ":robot: bot"
   - package-ecosystem: "docker"
     directory: "/.docker"
     schedule:

diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - main
+      - entelecheia/*
     # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory
     paths:
       - "book/**"
@@ -40,4 +41,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: book/_build/html
-          cname: 
+          cname: mlops2024.halla.ai
diff --git a/.github/workflows/lint_and_test.yaml b/.github/workflows/lint_and_test.yaml
@@ -6,11 +6,10 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - "*"
+      - "main"
     paths:
       - "src/**"
       - "tests/**"
-      - '.copier-template/**'
 
 jobs:
   build:
@@ -70,3 +69,10 @@ jobs:
           cat tests/pytest-coverage.txt >> $GITHUB_STEP_SUMMARY
           echo '```' >> $GITHUB_STEP_SUMMARY
           echo '\n\n\n'
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # required
+          fail_ci_if_error: false # optional (default = false)
+          verbose: true # optional (default = false)
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -8,7 +8,8 @@ on:
     branches:
       - release*
     paths:
-      - ".docker/**"
+      - 'src/**'
+      - 'pyproject.toml'
 
 permissions:
   contents: write
@@ -53,3 +54,5 @@ jobs:
           poetry run semantic-release publish --verbosity=DEBUG --define=branch=${{ env.BRANCH }}
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPOSITORY_USERNAME: __token__
+          REPOSITORY_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.tasks-extra.toml b/.tasks-extra.toml
@@ -1,6 +1,23 @@
-[tool.poe.tasks.hello]
-cmd = "echo 'Hello World'"
-help = "Put your extra tasks here"
+[tool.poe.tasks.add-editable-hyfi]
+shell = """
+  poetry remove hyfi
+  poetry add --group dev --editable ../hyfi
+"""
+help = "Add hyfi as an editable dependency"
+
+[tool.poe.tasks.apply-hyfi-template]
+cmd = """
+  copier --answers-file .copier-hyfi-config.yaml gh:entelecheia/hyfi-template .
+"""
+use_exec = true
+help = "Apply hyfi template"
+
+[tool.poe.tasks.copy-hyfi-config]
+shell = """
+  poetry add hyfi@latest
+  poetry run hyfi cmd=copy_conf copier.dst_path=src/mlops2024/conf copier.exclude='**/*/about/__init__.yaml' copier.overwrite=True
+"""
+help = "Copy hyfi conf to src/mlops2024/conf"
 
 [tool.poe.tasks.generate_toc]
 cmd = "python3 .github/scripts/autotoc.py"

diff --git a/.tasks.toml b/.tasks.toml
@@ -66,6 +66,14 @@ help = "remove documentation artifacts"
 sequence = ["clean-cov", "clean-pycache", "clean-build", "clean-docs"]
 help = "remove build artifacts and coverage reports"
 
+[tool.poe.tasks.run]
+cmd = "mlops2024"
+help = "run the main program"
+
+[tool.poe.tasks.build]
+cmd = "poetry build"
+help = "build the package"
+
 [tool.poe.tasks.install-ghp-import]
 cmd = "pipx install ghp-import"
 help = "install ghp-import"

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[entelecheia@hotmail.com](mailto:entelecheia@hotmail.com).
+[yj.lee@chu.ac.kr](mailto:yj.lee@chu.ac.kr).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,8 +25,8 @@ and "help wanted" is open to whoever wants to implement it.
 
 ## Write Documentation
 
-Course Template could always use more documentation, whether as part of the
-official Course Template docs, in docstrings, or even on the web in blog posts,
+머신러닝 시스템 디자인 2024 could always use more documentation, whether as part of the
+official 머신러닝 시스템 디자인 2024 docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 ## Submit Feedback
@@ -42,7 +42,7 @@ If you are proposing a feature:
 
 ## Get Started
 
-Ready to contribute? Here's how to set up `Course Template` for local development.
+Ready to contribute? Here's how to set up `머신러닝 시스템 디자인 2024` for local development.
 
 1. Fork the repo on GitHub.
 2. Clone your fork locally.
@@ -52,4 +52,4 @@ Ready to contribute? Here's how to set up `Course Template` for local developmen
 
 ## Code of Conduct
 
-Please note that the Course Template project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
+Please note that the 머신러닝 시스템 디자인 2024 project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -1,36 +1,47 @@
-# Course Template
-
+# 머신러닝 시스템 디자인 2024
 
+[![halla-img]][halla-url]
+[![course-img]][course-url]
+[![lecture-img]][lecture-url]
+[![pypi-image]][pypi-url]
 [![version-image]][release-url]
 [![release-date-image]][release-url]
 [![license-image]][license-url]
+[![codecov][codecov-image]][codecov-url]
 [![jupyter-book-image]][docs-url]
 
 <!-- Links: -->
-[codecov-image]: https://codecov.io/gh/entelecheia/course-template/branch/main/graph/badge.svg?token=[REPLACE_ME]
-[codecov-url]: https://codecov.io/gh/entelecheia/course-template
-[pypi-image]: https://img.shields.io/pypi/v/course-template
-[license-image]: https://img.shields.io/github/license/entelecheia/course-template
-[license-url]: https://github.com/entelecheia/course-template/blob/main/LICENSE
-[version-image]: https://img.shields.io/github/v/release/entelecheia/course-template?sort=semver
-[release-date-image]: https://img.shields.io/github/release-date/entelecheia/course-template
-[release-url]: https://github.com/entelecheia/course-template/releases
+[halla-img]: https://img.shields.io/badge/CHU-halla.ai-blue
+[halla-url]: https://halla.ai
+[course-img]: https://img.shields.io/badge/course-entelecheia.ai-blue
+[course-url]: https://course.entelecheia.ai
+[lecture-img]: https://img.shields.io/badge/lecture-entelecheia.ai-blue
+[lecture-url]: https://lecture.entelecheia.ai
+
+[codecov-image]: https://codecov.io/gh/chu-aie/mlops-2024/branch/main/graph/badge.svg?token=6OxfwdlW4Y
+[codecov-url]: https://codecov.io/gh/chu-aie/mlops-2024
+[pypi-image]: https://img.shields.io/pypi/v/mlops2024
+[license-image]: https://img.shields.io/github/license/chu-aie/mlops-2024
+[license-url]: https://github.com/chu-aie/mlops-2024/blob/main/LICENSE
+[version-image]: https://img.shields.io/github/v/release/chu-aie/mlops-2024?sort=semver
+[release-date-image]: https://img.shields.io/github/release-date/chu-aie/mlops-2024
+[release-url]: https://github.com/chu-aie/mlops-2024/releases
 [jupyter-book-image]: https://jupyterbook.org/en/stable/_images/badge.svg
 
-[repo-url]: https://github.com/entelecheia/course-template
-[pypi-url]: https://pypi.org/project/course-template
-[docs-url]: https://entelecheia.github.io/course-template
-[changelog]: https://github.com/entelecheia/course-template/blob/main/CHANGELOG.md
-[contributing guidelines]: https://github.com/entelecheia/course-template/blob/main/CONTRIBUTING.md
+[repo-url]: https://github.com/chu-aie/mlops-2024
+[pypi-url]: https://pypi.org/project/mlops2024
+[docs-url]: https://mlops2024.halla.ai
+[changelog]: https://github.com/chu-aie/mlops-2024/blob/main/CHANGELOG.md
+[contributing guidelines]: https://github.com/chu-aie/mlops-2024/blob/main/CONTRIBUTING.md
 <!-- Links: -->
 
-A template for a course
-
-- Documentation: [https://entelecheia.github.io/course-template][docs-url]
-- GitHub: [https://github.com/entelecheia/course-template][repo-url]
+Machine Learning Systems Design
 
+- Documentation: [https://mlops2024.halla.ai][docs-url]
+- GitHub: [https://github.com/chu-aie/mlops-2024][repo-url]
+- PyPI: [https://pypi.org/project/mlops2024][pypi-url]
 
-A template for a course
+이 수업은 실제 운영 환경에서 기계 학습 시스템의 설계, 구현 및 관리에 대한 실질적인 측면을 다룹니다. 본 과정은 학생들에게 기계 학습 워크플로를 기존 소프트웨어 개발 및 운영 프로세스와 원활하게 통합하는 데 필요한 기술을 제공합니다. 이 과정에서는 DevOps, MLOps 및 보안 관행을 강조합니다. 학생들은 실습 프로젝트를 통해 dot 파일, git, Docker, Kubernetes, CI/CD 파이프라인, Weights & Biases 등 첨단 도구와 방법론을 사용하여 강력한 기계 학습 모델을 구축, 배포하고 유지 관리합니다. 또한, 이 과정은 학생들에게 GitOps, DevSecOps 및 LLMOps의 새로운 분야를 소개하여 실제 기계 학습 애플리케이션의 복잡성에 대비합니다.
 
 ## Changelog
 

diff --git a/book/_config.yml b/book/_config.yml
@@ -5,7 +5,7 @@
 
 #######################################################################################
 # Book settings
-title: "Course Template" # The title of the book. Will be placed in the left navbar.
+title: "머신러닝 시스템 디자인 2024" # The title of the book. Will be placed in the left navbar.
 author: "Young Joon Lee" # The author of the book
 copyright: "2024" # Copyright year to be placed in the footer
 # logo: Path to the book logo
@@ -29,7 +29,7 @@ bibtex_bibfiles:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/entelecheia/course-template # Online location of your book
+  url: https://github.com/chu-aie/mlops-2024 # Online location of your book
   path_to_book: book # Optional path to your book, relative to the repository root
   branch: main # Which branch of the repository should be used when creating links (optional)
 
@@ -40,7 +40,17 @@ html:
   use_repository_button: true
   use_edit_page_button: true
   favicon: https://assets.entelecheia.ai/favicon.png # favicon: Path to the favicon image
-  # google_analytics_id: Google Analytics ID
+  google_analytics_id: G-BQJE5V9RK2 # google_analytics_id: Google Analytics ID
+  extra_footer: |
+      <script
+        data-embed-id="ed04ae65-928c-4ab5-912d-ce49f76450b7"
+        data-base-api-url="https://chat.entelecheia.app/api/embed"
+        data-brand-image-url="https://assets.entelecheia.ai/favicon.png"
+        data-chat-icon="magic"
+        data-sponsor-text="Cobots 2024"
+        data-sponsor-link="https://chat.entelecheia.app/workspace/cobots"
+        src="https://chat.entelecheia.app/embed/anythingllm-chat-widget.min.js">
+      </script>
 
 sphinx:
   config:

diff --git a/book/index.md b/book/index.md
@@ -1,37 +1,45 @@
-# Course Template
+# 머신러닝 시스템 디자인 2024
 
-[![version-image]][release-url]
+[![halla-img]][halla-url]
+[![course-img]][course-url]
+[![lecture-img]][lecture-url]
+[![pypi-image]][pypi-url]
 [![release-date-image]][release-url]
 [![license-image]][license-url]
-[![jupyter-book-image]][docs-url]
+[![codecov][codecov-image]][codecov-url]
 
 <!-- Links: -->
-[hyperfast python template]: https://github.com/entelecheia/hyperfast-python-template
-
-[codecov-image]: https://codecov.io/gh/entelecheia/course-template/branch/main/graph/badge.svg?token=[REPLACE_ME]
-[codecov-url]: https://codecov.io/gh/entelecheia/course-template
-[pypi-image]: https://img.shields.io/pypi/v/course-template
-[license-image]: https://img.shields.io/github/license/entelecheia/course-template
-[license-url]: https://github.com/entelecheia/course-template/blob/main/LICENSE
-[version-image]: https://img.shields.io/github/v/release/entelecheia/course-template?sort=semver
-[release-date-image]: https://img.shields.io/github/release-date/entelecheia/course-template
-[release-url]: https://github.com/entelecheia/course-template/releases
+
+[halla-img]: https://img.shields.io/badge/CHU-halla.ai-blue
+[halla-url]: https://halla.ai
+[course-img]: https://img.shields.io/badge/course-entelecheia.ai-blue
+[course-url]: https://course.entelecheia.ai
+[lecture-img]: https://img.shields.io/badge/lecture-entelecheia.ai-blue
+[lecture-url]: https://lecture.entelecheia.ai
+[codecov-image]: https://codecov.io/gh/chu-aie/mlops-2024/branch/main/graph/badge.svg?token=6OxfwdlW4Y
+[codecov-url]: https://codecov.io/gh/chu-aie/mlops-2024
+[pypi-image]: https://img.shields.io/pypi/v/mlops2024
+[license-image]: https://img.shields.io/github/license/chu-aie/mlops-2024
+[license-url]: https://github.com/chu-aie/mlops-2024/blob/main/LICENSE
+[version-image]: https://img.shields.io/github/v/release/chu-aie/mlops-2024?sort=semver
+[release-date-image]: https://img.shields.io/github/release-date/chu-aie/mlops-2024
+[release-url]: https://github.com/chu-aie/mlops-2024/releases
 [jupyter-book-image]: https://jupyterbook.org/en/stable/_images/badge.svg
+[repo-url]: https://github.com/chu-aie/mlops-2024
+[pypi-url]: https://pypi.org/project/mlops2024
+[docs-url]: https://mlops2024.halla.ai
+[changelog]: https://github.com/chu-aie/mlops-2024/blob/main/CHANGELOG.md
+[contributing guidelines]: https://github.com/chu-aie/mlops-2024/blob/main/CONTRIBUTING.md
 
-[repo-url]: https://github.com/entelecheia/course-template
-[pypi-url]: https://pypi.org/project/course-template
-[docs-url]: https://entelecheia.github.io/course-template
-[changelog]: https://github.com/entelecheia/course-template/blob/main/CHANGELOG.md
-[contributing guidelines]: https://github.com/entelecheia/course-template/blob/main/CONTRIBUTING.md
 <!-- Links: -->
 
-A template for a course
+이 수업은 실제 운영 환경에서 기계 학습 시스템의 설계, 구현 및 관리에 대한 실질적인 측면을 다룹니다. 본 과정은 학생들에게 기계 학습 워크플로를 기존 소프트웨어 개발 및 운영 프로세스와 원활하게 통합하는 데 필요한 기술을 제공합니다. 이 과정에서는 DevOps, MLOps 및 보안 관행을 강조합니다. 학생들은 실습 프로젝트를 통해 dot 파일, git, Docker, Kubernetes, CI/CD 파이프라인, Weights & Biases 등 첨단 도구와 방법론을 사용하여 강력한 기계 학습 모델을 구축, 배포하고 유지 관리합니다. 또한, 이 과정은 학생들에게 GitOps, DevSecOps 및 LLMOps의 새로운 분야를 소개하여 실제 기계 학습 애플리케이션의 복잡성에 대비합니다.
 
-- Documentation: [https://entelecheia.github.io/course-template][docs-url]
-- GitHub: [https://github.com/entelecheia/course-template][repo-url]
-- PyPI: [https://pypi.org/project/course-template][pypi-url]
+## Table of Contents
 
-A template for a course
+```{tableofcontents}
+
+```
 
 ## Changelog
 
@@ -44,8 +52,3 @@ Contributions are welcome! Please see the [contributing guidelines] for more inf
 ## License
 
 This project is released under the [CC-BY-4.0 License][license-url].
-
-## Table of Contents
-
-```{tableofcontents}
-```