chore: setup pre-commit (#37)

Author: iraedeus

.github/workflows/check.yml

@@ -11,27 +11,21 @@ jobs:
         python-version: [ "3.11", "3.12", "3.13" ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install poetry
-        run: pipx install poetry
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
 
       - name: Install dependencies
         run: poetry install --with dev
 
-      - name: Ruff
-        run: poetry run ruff check
+      - name: Run Pre-commit hooks
+        run: poetry run pre-commit run --all-files
 
-      - name: Install stubs
-        run: poetry run pip install types-PyYAML types-tqdm
-
-      - name: Mypy
-        run: poetry run mypy
-
-      - name: Pytest
-        run:  poetry run python -m pytest tests
+      - name: Run tests
+        run:  poetry run python -m pytest tests

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-merge-conflict
+    -   id: check-ast
+
+-   repo: local
+    hooks:
+    -   id: ruff-check
+        name: ruff check
+        entry: poetry run ruff check --fix --exit-non-zero-on-fix
+        language: system
+        types: [python]
+        files: ^(mpest/|experimental_env/|tests/).*
+
+    -   id: ruff-format
+        name: ruff format
+        entry: poetry run ruff format
+        language: system
+        types: [python]
+        files: ^(mpest/|experimental_env/|tests/).*
+
+    -   id: mypy
+        name: mypy check
+        entry: poetry run mypy
+        language: system
+        types: [python]
+        pass_filenames: false

CONTRIBUTING.md

@@ -35,7 +35,27 @@ git checkout -b <type>/<what-this-branch-solves>
 
 
 
-### 3. Make and Commit Changes
+### 3. Set Up Your Development Environment
+
+To start working on the code, you need to install the project dependencies and set up the pre-commit hooks. These hooks automatically check your code for quality and style before each commit.
+
+1. **Install dependencies:**
+
+   Follow steps in [README.md](README.md)
+
+2. **Install pre-commit hooks (Mandatory):**
+
+   ```bash
+   pre-commit install
+   ```
+
+   This command sets up the hooks in your local Git repository. **This is a required step for all contributors.**
+
+Now your environment is ready. The hooks will run automatically every time you run `git commit`.
+
+
+
+### 4. Make and Commit Changes
 
 Work on the code in your new branch. When you're ready to save your changes, create a commit. We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to standardize commit messages.
 
@@ -48,7 +68,7 @@ Use the following types:
 - `struct`: for changes related to the project structure (NOT CODE), for example, changing folder locations.
 - `ci`: for various CI/CD tasks.
 - `docs`: for changes in documentation.
-- `chore`: for other changes that do not affect the code or tests (e.g., updating .gitignore, README.md).
+- `chore`: for other changes that do not affect the code or tests (e.g., updating `.gitignore`, `README.md`).
 
 
 
@@ -64,7 +84,7 @@ Try to divide commits into atomic and independent parts. That is, do not add unr
 
 
 
-### 4. Push Changes to Your Fork
+### 5. Push Changes to Your Fork
 
 After you have made one or more commits, push your branch to your remote fork on GitHub:
 
@@ -74,13 +94,13 @@ git push
 
 
 
-### 5. Create a Pull Request (PR)
+### 6. Create a Pull Request (PR)
 
 Once your branch with the changes is in your fork, you can create a Pull Request to propose your changes to the main repository.
 
 1. Go to your fork's page on GitHub (https://github.com/YOUR-USERNAME/pysatl-mpest).
 2. You will see a notification prompting you to create a Pull Request for your recently pushed branch. Click the **"Compare & pull request"** button.
-3. Ensure the base repository is PySATL/pysatl-mpest with the main branch, and the head repository is your fork and your working branch.
+3. Ensure the base repository is `PySATL/pysatl-mpest` with the main branch, and the head repository is your fork and your working branch.
 4. Give your Pull Request a meaningful title (following the [Conventional Commits](https://www.google.com/url?sa=E&q=https%3A%2F%2Fwww.conventionalcommits.org%2F) standard) and add a detailed description of the changes you've made.
 
 #### Rules for Your PR to be Merged
@@ -98,6 +118,3 @@ For your Pull Request to be merged, it must meet the following requirements conf
 Each pull request must be reviewed by one of the maintainers:
 
 * Danil Totmyanin ([iraedeus](https://github.com/iraedeus))
-
-
-

docs/design.md

@@ -64,7 +64,7 @@
 
 ## 1.2. Цели документации
 
-Документ предназначен для описания текущего состояния проекта `pysatl-mpest`. 
+Документ предназначен для описания текущего состояния проекта `pysatl-mpest`.
 
 Целевой аудиторией являются разработчики, которые будут принимать участие в разработке/расширении библиотеки. По большей части данная документация предназначается для тех, кто будет разбираться со структурой проекта на *Летней школе*.
 
@@ -139,7 +139,7 @@ $$
 
 #### Смеси распределений
 
-Работа со смесями распределений идет через класс `MixtureDistribution`, который инициализируется с помощью списка объектов `Distribution`. Конкретные реализации распределений наследуются от `AModel`, после чего оборачиваются в класс `Distribution`. 
+Работа со смесями распределений идет через класс `MixtureDistribution`, который инициализируется с помощью списка объектов `Distribution`. Конкретные реализации распределений наследуются от `AModel`, после чего оборачиваются в класс `Distribution`.
 
 Некоторые реализации EM используют оптимизацию, при которой параметры могут выйти из области определения. Таким образом необходимо нормализовать параметры для того, чтобы они были определены на всем $\mathbb{R}$. Методы объектов `AModel` использует внутренние (internal) параметры, тогда как `Distribution` использует внешние (external) параметры, которые являются общепринятыми.
 
@@ -160,7 +160,7 @@ $$
 - `Python`: Как основной язык.
 - `scipy`: На эту библиотеку делегировано сэмплирование, а так же написаны адаптеры к их оптимизаторам.
 - `numpy`: Для векторизации.
-- `matplotlib + seaborn`: Для визуализации данных (В основном используется в экспериментальном окружении). 
+- `matplotlib + seaborn`: Для визуализации данных (В основном используется в экспериментальном окружении).
 
 
 
@@ -238,7 +238,7 @@ $$
     - `LikelihoodMStep` (для MLE-EM): пересчитывает параметры моделей, максимизируя взвешенную логарифмическую функцию правдоподобия. Может использовать `AOptimizer` или `AOptimizerJacobian` для численной оптимизации.
     - `LMomentsMStep` (для ELM): пересчитывает параметры моделей на основе вычисленных L-моментов для каждого компонента смеси.
 
-  
+
 
 ## 3.4. Вспомогательные
 
@@ -352,7 +352,7 @@ $$
 
   3. **M-шаг:** вызывается `method.m_step.step(e_result)`:
 
-     Реализуется M-шаг алгоритма, возвращая результирующую смесь. 
+     Реализуется M-шаг алгоритма, возвращая результирующую смесь.
 
   4. **Обновление состояния смеси:**
 
@@ -434,7 +434,7 @@ sequenceDiagram
 
 ### Ядро (Mpest core)
 
-1. Класс `Distribution` хоть и является оберткой для `AModel`, но не реализует всех его методов (например `lpdf`). Таким образом, для вызова нереализованных методов необходимо вызывать `model`, что плохо. 
+1. Класс `Distribution` хоть и является оберткой для `AModel`, но не реализует всех его методов (например `lpdf`). Таким образом, для вызова нереализованных методов необходимо вызывать `model`, что плохо.
 
 2. Для некоторых алгоритмов (не для всех) необходимо преобразовывать параметры так, чтобы они были на всем $\mathbb{R}$. Из-за этого появляется разделение на внутренние (*internal_params*) и внешние (*external_params*) параметры. Сейчас в коде, преобразование во внутренние параметры происходит перед началом алгоритма (для всех алгосов, даже для тех, для которых это не является необходимым), а в конце происходит переход к внешним параметрам (общепринятым).
 

docs/source/_static/EM algo.svg

@@ -21,4 +21,3 @@ documentation for details.
    :caption: API:
 
    api/modules
-

docs/source/index.rst

@@ -3,4 +3,4 @@
 :caption: Introduction:
 
 .. include:: ../../README.md
-   :parser: myst_parser.sphinx_
+   :parser: myst_parser.sphinx_

docs/source/intro.rst

@@ -4,10 +4,9 @@
 from itertools import permutations
 
 import numpy as np
-from scipy.integrate import quad
-
 from mpest import MixtureDistribution
 from mpest.utils import ANamed
+from scipy.integrate import quad
 
 
 class AMetric(ANamed, ABC):

experimental_env/analysis/metrics.py

@@ -5,16 +5,16 @@
 from concurrent.futures import as_completed
 from concurrent.futures.process import ProcessPoolExecutor
 
-from tqdm import tqdm
-
-from experimental_env.utils import OrderedProblem, choose_best_mle
 from mpest import Problem
 from mpest.em import EM
 from mpest.em.methods.l_moments_method import LMomentsMStep
 from mpest.em.methods.likelihood_method import BayesEStep, LikelihoodMStep
 from mpest.em.methods.method import Method
 from mpest.optimizers import ALL_OPTIMIZERS
 from mpest.utils import ANamed, Factory, ResultWithLog
+from tqdm import tqdm
+
+from experimental_env.utils import OrderedProblem, choose_best_mle
 
 METHODS: dict = {
     "Likelihood": [[Factory(BayesEStep), Factory(LikelihoodMStep, optimizer)] for optimizer in ALL_OPTIMIZERS],

experimental_env/experiment/estimators.py

@@ -3,11 +3,11 @@
 from collections.abc import Iterable, Iterator
 
 import numpy as np
-
-from experimental_env.preparation.dataset_description import DatasetDescrciption
 from mpest import MixtureDistribution
 from mpest.utils import ResultWithLog
 
+from experimental_env.preparation.dataset_description import DatasetDescrciption
+
 
 class StepDescription:
     """