machinelens 0.1.1

Installation

pip install machinelens

uv pip install machinelens

Quick Start

Classification model

from sklearn.ensemble import RandomForestClassifier
from sklearn.datasets import make_classification
from sklearn.model_selection import train_test_split
import pandas as pd

from machinelens import ModelInterface, ModelAnalyzer, DiagnosticPlotter

# 1. Prepare data and train a model
X, y = make_classification(n_samples=1000, random_state=42)
X_df = pd.DataFrame(X, columns=[f"feature_{i}" for i in range(X.shape[1])])
X_train, X_test, y_train, y_test = train_test_split(X_df, y, test_size=0.2)
model = RandomForestClassifier(random_state=42).fit(X_train, y_train)

# 2. Wrap the model
interface = ModelInterface(model, X_train, X_test, y_train, y_test)

# 3. Run diagnostics
results = ModelAnalyzer(interface).analyze()

# 4. Visualise
plotter = DiagnosticPlotter(results)
plotter.plot_metrics().show()
plotter.plot_roc_curve().show()
plotter.plot_shap_beeswarm().show()

Regression model

from sklearn.ensemble import RandomForestRegressor
from sklearn.datasets import make_regression
from sklearn.model_selection import train_test_split
import pandas as pd

from machinelens import ModelInterface, ModelAnalyzer, DiagnosticPlotter

X, y = make_regression(n_samples=500, n_features=20, noise=15.0, random_state=42)
X_df = pd.DataFrame(X, columns=[f"Feature_{i+1}" for i in range(X.shape[1])])
X_train, X_test, y_train, y_test = train_test_split(X_df, y, test_size=0.2, random_state=42)

model = RandomForestRegressor(n_estimators=50, random_state=42).fit(X_train, y_train)
interface = ModelInterface(model, X_train, X_test, y_train, y_test)
results = ModelAnalyzer(interface).analyze()

plotter = DiagnosticPlotter(results)
plotter.plot_metrics().show()
plotter.plot_residuals().show()
plotter.plot_shap_beeswarm().show()

Development

We welcome contributions! MachineLens is built with modern Python tooling to ensure code quality and ease of development.

pytest

Help and Support

Communication

• GitHub Discussions: https://github.com/VazFabricio/MachineLens/discussions

• Issues: https://github.com/VazFabricio/MachineLens/issues

License

MachineLens is distributed under the BSD 3-Clause License. See LICENSE for more information.