This is a repository for machine learning playground and sample codes. I want to organize samples for myself because sample codes for machine learning are often of low quality.

• GitHub Actions runs tests for each version of Python (3.9 - 3.12) always.
  • Python 3.8, which is the LTS of Python, will be provided with security fixes until 2024. https://devguide.python.org/versions/
  • numpy has ended support for Python 3.8 due to NEP 29. https://numpy.org/neps/nep-0029-deprecation_policy.html
• Renovate continuously updates dependencies.
• Codecov measures test coverage.
• nbmake tests Jupyter ipynb files.

By doing so, I will ensure that sample codes always function as samples.

機械学習の実験場・サンプルコードのリポジトリです。 機械学習周りのサンプルコードはクォリティが高くないことが多いので、自分用にサンプルを整理したいと考えています。

• GitHub Actions で常に各バージョンの Python (3.9 - 3.12) でテストが実行されます。
  • Python の　LTS である 3.8 は 2024 年まで security fix が提供されます。 https://devguide.python.org/versions/
  • numpy は NEP 29 により Python 3.8 のサポートを終了しています。 https://numpy.org/neps/nep-0029-deprecation_policy.html
• Renovate が継続的に依存パッケージを更新します。
• Codecov がテストカバレッジを計測します。
• nbmake で Jupyter の ipynb ファイルもテストします。

これらによって、サンプルコードが常にサンプルとして機能することを保証していきます。

Install dependencies with poetry.

poetry install

This project uses typos. Please install it according to https://github.com/crate-ci/typos#install

poetry self add 'poethepoet[poetry_plugin]'

poetry poe test

poetry poe format

• isort for import sorting
• black for formatting
• pyupgrade for upgrading syntax to the latest version of Python

poetry poe check

• mypy for static type checking
• flake8 for linting
• black for formatting check
• isort for import sorting check

MIT License