feat: New public API making usage more simple (#17)

cmnemoi · Sep 16, 2023 · db1aa7e · db1aa7e
1 parent 6d5883f
commit db1aa7e
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 7 deletions.
diff --git a/cmnemoi_learn/__init__.py b/cmnemoi_learn/__init__.py
@@ -0,0 +1,6 @@
+"""
+cmnemoi-learn is a personal reimplementation of Machine Learning algorithms 
+with high quality development practices.
+"""
+
+__all__ = ["classification", "regression"]
diff --git a/cmnemoi_learn/abstract_model.py → cmnemoi_learn/_abstract_model.py b/cmnemoi_learn/abstract_model.py → cmnemoi_learn/_abstract_model.py
diff --git a/cmnemoi_learn/classification/__init__.py b/cmnemoi_learn/classification/__init__.py
@@ -0,0 +1,7 @@
+"""
+Module implementing machine learning models for regression tasks.
+"""
+
+from ._logistic_regression import LogisticRegression
+
+__all__ = ["LogisticRegression"]
diff --git a/...arn/classification/abstract_classifier.py → ...rn/classification/_abstract_classifier.py b/...arn/classification/abstract_classifier.py → ...rn/classification/_abstract_classifier.py
@@ -4,7 +4,7 @@
 
 import numpy as np
 
-from cmnemoi_learn.abstract_model import AbstractModel
+from .._abstract_model import AbstractModel
 
 
 class AbstractClassifier(AbstractModel):

diff --git a/...arn/classification/logistic_regression.py → ...rn/classification/_logistic_regression.py b/...arn/classification/logistic_regression.py → ...rn/classification/_logistic_regression.py
@@ -4,7 +4,7 @@
 from typing import Optional, Self
 import numpy as np
 
-from cmnemoi_learn.classification.abstract_classifier import AbstractClassifier
+from ._abstract_classifier import AbstractClassifier
 
 
 class LogisticRegression(AbstractClassifier):

diff --git a/cmnemoi_learn/regression/__init__.py b/cmnemoi_learn/regression/__init__.py
@@ -0,0 +1,7 @@
+"""
+Module implementing machine learning models for regression tasks.
+"""
+
+from ._linear_regression import LinearRegression
+
+__all__ = ["LinearRegression"]
diff --git a/...oi_learn/regression/abstract_regressor.py → ...i_learn/regression/_abstract_regressor.py b/...oi_learn/regression/abstract_regressor.py → ...i_learn/regression/_abstract_regressor.py
@@ -4,7 +4,7 @@
 
 import numpy as np
 
-from cmnemoi_learn.abstract_model import AbstractModel
+from .._abstract_model import AbstractModel
 
 
 class AbstractRegressor(AbstractModel):

diff --git a/...moi_learn/regression/linear_regression.py → ...oi_learn/regression/_linear_regression.py b/...moi_learn/regression/linear_regression.py → ...oi_learn/regression/_linear_regression.py
@@ -6,7 +6,7 @@
 import numpy as np
 from numpy.linalg import pinv
 
-from cmnemoi_learn.regression.abstract_regressor import AbstractRegressor
+from ._abstract_regressor import AbstractRegressor
 
 
 class LinearRegression(AbstractRegressor):

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmnemoi-learn"
-version = "0.3.0"
+version = "0.4.0"
 description = "Machine Learning from scratch by Charles-Meldhine Madi Mnemoi"
 authors = ["Charles-Meldhine Madi Mnemoi <[email protected]>"]
 license = "MIT"

diff --git a/tests/classification/test_logistic_regression.py b/tests/classification/test_logistic_regression.py
@@ -6,7 +6,7 @@
 from sklearn.linear_model import LogisticRegression as SklearnLogisticRegression
 from sklearn.metrics import accuracy_score
 
-from cmnemoi_learn.classification.logistic_regression import LogisticRegression
+from cmnemoi_learn.classification import LogisticRegression
 
 RANDOM_STATE = 42
 

diff --git a/tests/regression/test_linear_regression.py b/tests/regression/test_linear_regression.py
@@ -6,7 +6,7 @@
 from sklearn.linear_model import LinearRegression as SklearnLinearRegression
 from sklearn.metrics import mean_squared_error
 
-from cmnemoi_learn.regression.linear_regression import LinearRegression
+from cmnemoi_learn.regression import LinearRegression
 
 np.random.seed(42)