diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c227a080..e5006e33 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -36,4 +36,7 @@ jobs: # path: .cache # restore-keys: | # mkdocs-material- - - run: pdm run mkdocs gh-deploy --force + - name: Deploy docs + run: | + pdm run mike deploy --push --update-aliases $(pdm show --version) latest + pdm run mike set-default --push latest diff --git a/Makefile b/Makefile index 337566b8..a24d8312 100644 --- a/Makefile +++ b/Makefile @@ -58,7 +58,7 @@ generate-docs: .PHONY: serve-docs ## Serve the docs serve-docs: - pdm run mkdocs serve + pdm run mike serve .PHONY: version ## Check project version version: diff --git a/docs/api/optimizers/evaluators.md b/docs/api/optimizers/evaluators.md new file mode 100644 index 00000000..dfc7ed54 --- /dev/null +++ b/docs/api/optimizers/evaluators.md @@ -0,0 +1 @@ +::: siapy.optimizers.evaluators diff --git a/docs/api/utils/evaluators.md b/docs/api/utils/evaluators.md deleted file mode 100644 index 47a9d624..00000000 --- a/docs/api/utils/evaluators.md +++ /dev/null @@ -1 +0,0 @@ -::: siapy.utils.evaluators diff --git a/mkdocs.yml b/mkdocs.yml index 42978a7a..651f2151 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -100,6 +100,7 @@ nav: - Metrics: api/models/metrics.md - Optimizers: - Configs: api/optimizers/configs.md + - Evaluators: api/optimizers/evaluators.md - Optimizers: api/optimizers/optimizers.md - Parameters: api/optimizers/parameters.md - Scorers: api/optimizers/scorers.md @@ -107,7 +108,6 @@ nav: - Corregistrator: api/transformations/corregistrator.md - Image: api/transformations/image.md - Utils: - - Evaluators: api/utils/evaluators.md - Images: api/utils/images.md - Plots: api/utils/plots.md - Release Notes: changelog.md @@ -172,6 +172,7 @@ plugins: - mike: alias_type: symlink canonical_version: latest + version_selector: true - search - exclude: glob: @@ -198,6 +199,6 @@ plugins: docstring_section_style: spacy show_symbol_type_heading: true show_symbol_type_toc: true - import: + inventories: - https://docs.python.org/3/objects.inv - external-markdown: diff --git a/siapy/utils/evaluators.py b/siapy/optimizers/evaluators.py similarity index 97% rename from siapy/utils/evaluators.py rename to siapy/optimizers/evaluators.py index c32e6528..01d2a462 100644 --- a/siapy/utils/evaluators.py +++ b/siapy/optimizers/evaluators.py @@ -12,8 +12,7 @@ from siapy.core import logger from siapy.core.exceptions import InvalidInputError from siapy.core.types import ArrayLike1dType, ArrayLike2dType - -from .validators import check_model_prediction_methods +from siapy.utils.validators import check_model_prediction_methods __all__ = [ "cross_validation", diff --git a/siapy/optimizers/scorers.py b/siapy/optimizers/scorers.py index 62d7751b..2074e5f4 100644 --- a/siapy/optimizers/scorers.py +++ b/siapy/optimizers/scorers.py @@ -6,7 +6,7 @@ from sklearn.base import BaseEstimator from siapy.core.types import ArrayLike1dType, ArrayLike2dType -from siapy.utils.evaluators import ( +from siapy.optimizers.evaluators import ( ScorerFuncType, cross_validation, hold_out_validation, diff --git a/siapy/utils/enums.py b/siapy/utils/enums.py deleted file mode 100644 index 4bc990cf..00000000 --- a/siapy/utils/enums.py +++ /dev/null @@ -1,11 +0,0 @@ -from enum import Enum, auto - -__all__ = [ - "InteractiveButtonsEnum", -] - - -class InteractiveButtonsEnum(Enum): - SAVE = auto() - REPEAT = auto() - SKIP = auto() diff --git a/siapy/utils/plots.py b/siapy/utils/plots.py index c9bdb77d..511f2556 100644 --- a/siapy/utils/plots.py +++ b/siapy/utils/plots.py @@ -1,4 +1,5 @@ import sys +from enum import Enum, auto from typing import Any import matplotlib.pyplot as plt @@ -13,7 +14,6 @@ from siapy.core.types import ImageType from siapy.datasets.schemas import ClassificationTarget, TabularDatasetData from siapy.entities import Pixels -from siapy.utils.enums import InteractiveButtonsEnum from siapy.utils.validators import validate_image_to_numpy_3channels __all__ = [ @@ -22,6 +22,7 @@ "display_image_with_areas", "display_multiple_images_with_areas", "display_signals", + "InteractiveButtonsEnum", ] @@ -151,6 +152,12 @@ def display_image_with_areas( plt.show() +class InteractiveButtonsEnum(Enum): + SAVE = auto() + REPEAT = auto() + SKIP = auto() + + def display_multiple_images_with_areas( images_with_areas: list[tuple[ImageType, Pixels | list[Pixels]]], *, diff --git a/tests/utils/test_utils_evaluators.py b/tests/optimizers/test_optimizers_evaluators.py similarity index 98% rename from tests/utils/test_utils_evaluators.py rename to tests/optimizers/test_optimizers_evaluators.py index 9d4792b2..d571c186 100644 --- a/tests/utils/test_utils_evaluators.py +++ b/tests/optimizers/test_optimizers_evaluators.py @@ -7,7 +7,7 @@ from sklearn.svm import SVC from siapy.core.exceptions import InvalidInputError -from siapy.utils.evaluators import ( +from siapy.optimizers.evaluators import ( cross_validation, hold_out_validation, ) diff --git a/tests/utils/test_utils_plots.py b/tests/utils/test_utils_plots.py index d21000c6..ce3e835e 100644 --- a/tests/utils/test_utils_plots.py +++ b/tests/utils/test_utils_plots.py @@ -5,8 +5,8 @@ RegressionTarget, TabularDatasetData, ) -from siapy.utils.enums import InteractiveButtonsEnum from siapy.utils.plots import ( + InteractiveButtonsEnum, display_image_with_areas, display_multiple_images_with_areas, display_signals,