utilsds-models 0.0.1__tar.gz → 0.0.3__tar.gz

utilsds_models-0.0.3/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: utilsds-models
+Version: 0.0.3
+Summary: Solution for specific models
+Author-email: DS Team <ds@sts.pl>
+License: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: scikit-learn>=1.5.0
+Requires-Dist: matplotlib>=3.9.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.5.0; extra == "dev"
+
+# utilsds-models
+
+A library of classes and functions used in DS Team modeling projects.
+It extends the [utilsds](https://pypi.org/project/utilsds/) package with components specific to selected models
+(data processing, NGR metrics, EVIP metrics, and a custom LightGBM objective).
+
+Requires Python >= 3.12.
+
+## Installation
+
+```bash
+uv sync
+source .venv/bin/activate
+```
+
+Or from PyPI (after publication):
+
+```bash
+pip install utilsds-models
+```
+
+## Modules
+
+### `data_processing`
+
+Scikit-learn-compatible classes and helper functions for combining test results.
+
+- **`ColumnCopyImputer`**: fills missing values by copying from other columns.
+- **`NullImputerWithFlags`**: imputes nulls with optional flags (`_isnull_flag`) and strategies `mean`, `median`, `mode`.
+- **`MaxMultiplierImputer`**: imputes using `max * multiplier` from training data, with optional flags.
+- **`SportsHybridEncoder`**: encodes sports as binary features for the top N disciplines plus aggregations for the rest.
+- **`LabelEncoderTransformer`**: label encoding for categorical columns (e.g. for LightGBM).
+- **`DerivedFeatureCreator`**: creates derived features (e.g. division by 7 or 30).
+- **`combine_test_data`**: combines test features, target, predictions, and metadata into a single DataFrame.
+
+### `custom_metrics`
+
+Evaluation metrics with time-based weights (`days_since_ftd`) and a custom LightGBM objective.
+
+- **`EvalMetric`**: cohort-level (aggregated by `days_since_ftd`) and sample-level metrics with time-decay weighting:
+  - `cohort_weighted_mae`, `cohort_weighted_mse`, `cohort_weighted_mape`
+  - `sample_weighted_mae`, `sample_weighted_mse`, `sample_weighted_mape`
+  - `create_lgb_metric`: factory for LightGBM metrics with time weights
+- **`DaysWeightedObjective`**: custom LightGBM objective with time weights (modes: `mae`, `mse`, `mape`).
+
+### `metrics`
+
+- **`calculate_ngr_metrics`**: computes NGR error metrics (MAE, MAPE, ME, MPE) in both standard
+  and business-optimal variants with weights based on `days_since_ftd`. Optionally applies late-stage
+  prediction correction over the customer lifecycle.
+
+### `visualization`
+
+- **`calculate_ngr_metrics`**: NGR evaluation function (equivalent to the `metrics` module).
+
+### `evip_dynamic`
+
+Classification metrics with a false-positive (FP) budget constraint.
+
+- **`recall_with_fp_cap`**: recall with a penalty for exceeding the FP budget in binary classification.
+- **`weighted_premium_recall_with_fp_cap`**: weighted recall for premium classes (1 and 2) with a penalty
+  for exceeding the FPR budget among class 0 samples.
+
+## Dependencies
+
+- `pandas>=2.2.2`
+- `numpy>=1.26.0`
+- `scikit-learn>=1.5.0`
+- `matplotlib>=3.9.0`
+
+## Publishing to PyPI
+
+```bash
+uv pip install build twine
+uv run python -m build
+twine upload --skip-existing dist/*
+```
+
+Before publishing, bump the version in `pyproject.toml` (section `[project]`).

utilsds_models-0.0.3/docs/ALTERNATIVE_README.md

@@ -0,0 +1,79 @@
+# utilsds-models
+
+A library of classes and functions used in DS Team modeling projects.
+It extends the [utilsds](https://pypi.org/project/utilsds/) package with components specific to selected models
+(data processing, NGR metrics, EVIP metrics, and a custom LightGBM objective).
+
+Requires Python >= 3.12.
+
+## Installation
+
+```bash
+uv sync
+source .venv/bin/activate
+```
+
+Or from PyPI (after publication):
+
+```bash
+pip install utilsds-models
+```
+
+## Modules
+
+### `data_processing`
+
+Scikit-learn-compatible classes and helper functions for combining test results.
+
+- **`ColumnCopyImputer`**: fills missing values by copying from other columns.
+- **`NullImputerWithFlags`**: imputes nulls with optional flags (`_isnull_flag`) and strategies `mean`, `median`, `mode`.
+- **`MaxMultiplierImputer`**: imputes using `max * multiplier` from training data, with optional flags.
+- **`SportsHybridEncoder`**: encodes sports as binary features for the top N disciplines plus aggregations for the rest.
+- **`LabelEncoderTransformer`**: label encoding for categorical columns (e.g. for LightGBM).
+- **`DerivedFeatureCreator`**: creates derived features (e.g. division by 7 or 30).
+- **`combine_test_data`**: combines test features, target, predictions, and metadata into a single DataFrame.
+
+### `custom_metrics`
+
+Evaluation metrics with time-based weights (`days_since_ftd`) and a custom LightGBM objective.
+
+- **`EvalMetric`**: cohort-level (aggregated by `days_since_ftd`) and sample-level metrics with time-decay weighting:
+  - `cohort_weighted_mae`, `cohort_weighted_mse`, `cohort_weighted_mape`
+  - `sample_weighted_mae`, `sample_weighted_mse`, `sample_weighted_mape`
+  - `create_lgb_metric`: factory for LightGBM metrics with time weights
+- **`DaysWeightedObjective`**: custom LightGBM objective with time weights (modes: `mae`, `mse`, `mape`).
+
+### `metrics`
+
+- **`calculate_ngr_metrics`**: computes NGR error metrics (MAE, MAPE, ME, MPE) in both standard
+  and business-optimal variants with weights based on `days_since_ftd`. Optionally applies late-stage
+  prediction correction over the customer lifecycle.
+
+### `visualization`
+
+- **`calculate_ngr_metrics`**: NGR evaluation function (equivalent to the `metrics` module).
+
+### `evip_dynamic`
+
+Classification metrics with a false-positive (FP) budget constraint.
+
+- **`recall_with_fp_cap`**: recall with a penalty for exceeding the FP budget in binary classification.
+- **`weighted_premium_recall_with_fp_cap`**: weighted recall for premium classes (1 and 2) with a penalty
+  for exceeding the FPR budget among class 0 samples.
+
+## Dependencies
+
+- `pandas>=2.2.2`
+- `numpy>=1.26.0`
+- `scikit-learn>=1.5.0`
+- `matplotlib>=3.9.0`
+
+## Publishing to PyPI
+
+```bash
+uv pip install build twine
+uv run python -m build
+twine upload --skip-existing dist/*
+```
+
+Before publishing, bump the version in `pyproject.toml` (section `[project]`).

{utilsds_models-0.0.1 → utilsds_models-0.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "utilsds-models"
-version = "0.0.1"
+version = "0.0.3"
 description = "Solution for specific models"
 readme = {file = "docs/ALTERNATIVE_README.md", content-type = "text/markdown"}
 requires-python = ">=3.12"

utilsds_models-0.0.3/utilsds_models.egg-info/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: utilsds-models
+Version: 0.0.3
+Summary: Solution for specific models
+Author-email: DS Team <ds@sts.pl>
+License: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: scikit-learn>=1.5.0
+Requires-Dist: matplotlib>=3.9.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.5.0; extra == "dev"
+
+# utilsds-models
+
+A library of classes and functions used in DS Team modeling projects.
+It extends the [utilsds](https://pypi.org/project/utilsds/) package with components specific to selected models
+(data processing, NGR metrics, EVIP metrics, and a custom LightGBM objective).
+
+Requires Python >= 3.12.
+
+## Installation
+
+```bash
+uv sync
+source .venv/bin/activate
+```
+
+Or from PyPI (after publication):
+
+```bash
+pip install utilsds-models
+```
+
+## Modules
+
+### `data_processing`
+
+Scikit-learn-compatible classes and helper functions for combining test results.
+
+- **`ColumnCopyImputer`**: fills missing values by copying from other columns.
+- **`NullImputerWithFlags`**: imputes nulls with optional flags (`_isnull_flag`) and strategies `mean`, `median`, `mode`.
+- **`MaxMultiplierImputer`**: imputes using `max * multiplier` from training data, with optional flags.
+- **`SportsHybridEncoder`**: encodes sports as binary features for the top N disciplines plus aggregations for the rest.
+- **`LabelEncoderTransformer`**: label encoding for categorical columns (e.g. for LightGBM).
+- **`DerivedFeatureCreator`**: creates derived features (e.g. division by 7 or 30).
+- **`combine_test_data`**: combines test features, target, predictions, and metadata into a single DataFrame.
+
+### `custom_metrics`
+
+Evaluation metrics with time-based weights (`days_since_ftd`) and a custom LightGBM objective.
+
+- **`EvalMetric`**: cohort-level (aggregated by `days_since_ftd`) and sample-level metrics with time-decay weighting:
+  - `cohort_weighted_mae`, `cohort_weighted_mse`, `cohort_weighted_mape`
+  - `sample_weighted_mae`, `sample_weighted_mse`, `sample_weighted_mape`
+  - `create_lgb_metric`: factory for LightGBM metrics with time weights
+- **`DaysWeightedObjective`**: custom LightGBM objective with time weights (modes: `mae`, `mse`, `mape`).
+
+### `metrics`
+
+- **`calculate_ngr_metrics`**: computes NGR error metrics (MAE, MAPE, ME, MPE) in both standard
+  and business-optimal variants with weights based on `days_since_ftd`. Optionally applies late-stage
+  prediction correction over the customer lifecycle.
+
+### `visualization`
+
+- **`calculate_ngr_metrics`**: NGR evaluation function (equivalent to the `metrics` module).
+
+### `evip_dynamic`
+
+Classification metrics with a false-positive (FP) budget constraint.
+
+- **`recall_with_fp_cap`**: recall with a penalty for exceeding the FP budget in binary classification.
+- **`weighted_premium_recall_with_fp_cap`**: weighted recall for premium classes (1 and 2) with a penalty
+  for exceeding the FPR budget among class 0 samples.
+
+## Dependencies
+
+- `pandas>=2.2.2`
+- `numpy>=1.26.0`
+- `scikit-learn>=1.5.0`
+- `matplotlib>=3.9.0`
+
+## Publishing to PyPI
+
+```bash
+uv pip install build twine
+uv run python -m build
+twine upload --skip-existing dist/*
+```
+
+Before publishing, bump the version in `pyproject.toml` (section `[project]`).

utilsds_models-0.0.3/utilsds_models.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+docs/ALTERNATIVE_README.md
+utilsds_models.egg-info/PKG-INFO
+utilsds_models.egg-info/SOURCES.txt
+utilsds_models.egg-info/dependency_links.txt
+utilsds_models.egg-info/requires.txt
+utilsds_models.egg-info/top_level.txt

utilsds_models-0.0.3/utilsds_models.egg-info/top_level.txt

@@ -0,0 +1 @@
+

utilsds_models-0.0.1/PKG-INFO

@@ -1,106 +0,0 @@
-Metadata-Version: 2.4
-Name: utilsds-models
-Version: 0.0.1
-Summary: Solution for specific models
-Author-email: DS Team <ds@sts.pl>
-License: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: pandas>=2.2.2
-Requires-Dist: numpy>=1.26.0
-Requires-Dist: scikit-learn>=1.5.0
-Requires-Dist: matplotlib>=3.9.0
-Provides-Extra: dev
-Requires-Dist: pre-commit>=3.5.0; extra == "dev"
-
-# utilsds
-
-Utilsds is a library that includes classes and functions used in data science projects such as:
-
-- **algorithm**:
-  - `Algorithm`: Base class for fitting, training, and getting hyperparameters of machine learning models.
-
-- **data_ops**:
-  - `DataOperations`: Handle data operations locally and with Google Cloud services (BigQuery and Cloud Storage).
-  - BigQuery operations:
-    - `load_bq_data`: Load data from tables, views, and SQL files.
-    - `save_bq_view`, `save_bq_table`: Save views and tables.
-    - `load_bq_procedure`: Execute stored procedures.
-    - `load_bq_details`: Get table/view details and schema.
-    - `delete_bq_data`: Delete data with safety confirmations.
-    - `dry_run`: Perform dry runs to estimate query costs.
-  - Cloud Storage operations:
-    - `save_gcs_bucket`: Create buckets.
-    - `save_gcs_file`, `load_gcs_file`: Save and load files (.pkl, .json, .csv, .html, .sql).
-  - Local file operations:
-    - `save_local_file`, `load_local_file`: Save and load files (.pkl, .json, .csv, .html, .sql).
-
-- **data_processing**:
-  - `SkewnessTransformer`: Transform skewed data using various methods (IHS, neglog, Yeo-Johnson, quantile).
-  - `NullReplacer`: Replace null values in specified columns with configurable strategies.
-  - `ColumnDropper`: Drop specified columns from a DataFrame.
-  - `OutliersCleaner`: Clean outliers by clipping values outside specified percentile ranges.
-  - `CategoricalMapper`: Map values in categorical columns according to a specified mapping scheme.
-  - `NumericalMapper`: Convert numerical columns to categorical by binning.
-  - `Encoder`: One-hot encode categorical columns in the data.
-  - `Normalizer`: Normalize numerical columns using a provided scaler.
-
-- **data_split**:
-  - `train_test_validation_split`: Split data into training, testing, and validation sets.
-  - `resample_X_y`: resample train data and target column.
-
-- **ds_statistics**:
-  - `test_kruskal_wallis`: Perform the Kruskal-Wallis statistical test.
-  - `test_agosto_pearsona`: Test for normality using D'Agostino-Pearson test.
-
-- **evaluate**:
-  - `ModelEvaluator`: Evaluate models and generate plots for diagnostics.
-  - `ShapExplainer`: Explain model predictions using SHAP values.
-
-- **experiments**:
-  - `VertexExperiment`: Manage experiments with Vertex AI.
-
-- **optuna**:
-  - `Optuna`: Optimize hyperparameters using Optuna.
-
-- **metrics**:
-  - `Metrics`: Calculate metrics for both classification and regression models.
-
-- **modeling**:
-  - `Modeling`: Manage modeling, metrics, and logging with Vertex AI.
-
-- **Supervised**:
-  - `LazyClassifier`: A classifier that automatically trains and evaluates multiple models.
-  - `LazyRegressor`: A regressor that automatically trains and evaluates multiple models.
-  - `get_card_split`: Function to split data into card-like groups.
-  - `adjusted_rsquared`: Calculate adjusted R-squared for regression models.
-
-- **visualization**:
-  - `MetricsPlot`: Compare metrics for different parameter values.
-  - `Radar`: Create radar plots for visualizing data.
-  - `cluster_characteristics`: Analyze cluster characteristics.
-  - `comparison_density`: Compare density distributions.
-  - `elbow_visualisation`: Visualize the elbow method for clustering.
-  - `describe_clusters_metrics`: Describe metrics for clusters.
-  - `category_null_variables`: Visualize null variables in categorical data.
-  - `normal_distr_plots`: Visualize normal distribution plots.
-  - `distplot_limitations`: Visualize limitations of distplot.
-  - `boxplot_limitations`: Visualize limitations of boxplot.
-  - `violinplot_limitations`: Visualize limitations of violinplot.
-  - `countplot_limitations`: Visualize limitations of countplot.
-  - `categorical_variable_perc`: Visualize percentage of categorical variables.
-  - `spearman_correlation`: Visualize spearman correlation.
-  - `calculate_crammers_v`: Calculate Crammer's V.
-
-- **what_if_streamlit**:
-  - `ShapSaver`: Save SHAP explainer components for lazy loading in what-if analysis.
-  - `ColumnMetadataGenerator`: Generate column metadata from a DataFrame or CSV file.
-
-- **monitoring**:
-  - `mapping`: Create column mapping from configuration file for Evidently.
-  - `test_data`: Test data for issues using Evidently test suites.
-  - `check_data_drift`: Check data for drift using Evidently metrics.
-  - `send_email_with_table`: Send email notifications with HTML tables for monitoring alerts.

utilsds_models-0.0.1/docs/ALTERNATIVE_README.md

@@ -1,88 +0,0 @@
-# utilsds
-
-Utilsds is a library that includes classes and functions used in data science projects such as:
-
-- **algorithm**:
-  - `Algorithm`: Base class for fitting, training, and getting hyperparameters of machine learning models.
-
-- **data_ops**:
-  - `DataOperations`: Handle data operations locally and with Google Cloud services (BigQuery and Cloud Storage).
-  - BigQuery operations:
-    - `load_bq_data`: Load data from tables, views, and SQL files.
-    - `save_bq_view`, `save_bq_table`: Save views and tables.
-    - `load_bq_procedure`: Execute stored procedures.
-    - `load_bq_details`: Get table/view details and schema.
-    - `delete_bq_data`: Delete data with safety confirmations.
-    - `dry_run`: Perform dry runs to estimate query costs.
-  - Cloud Storage operations:
-    - `save_gcs_bucket`: Create buckets.
-    - `save_gcs_file`, `load_gcs_file`: Save and load files (.pkl, .json, .csv, .html, .sql).
-  - Local file operations:
-    - `save_local_file`, `load_local_file`: Save and load files (.pkl, .json, .csv, .html, .sql).
-
-- **data_processing**:
-  - `SkewnessTransformer`: Transform skewed data using various methods (IHS, neglog, Yeo-Johnson, quantile).
-  - `NullReplacer`: Replace null values in specified columns with configurable strategies.
-  - `ColumnDropper`: Drop specified columns from a DataFrame.
-  - `OutliersCleaner`: Clean outliers by clipping values outside specified percentile ranges.
-  - `CategoricalMapper`: Map values in categorical columns according to a specified mapping scheme.
-  - `NumericalMapper`: Convert numerical columns to categorical by binning.
-  - `Encoder`: One-hot encode categorical columns in the data.
-  - `Normalizer`: Normalize numerical columns using a provided scaler.
-
-- **data_split**:
-  - `train_test_validation_split`: Split data into training, testing, and validation sets.
-  - `resample_X_y`: resample train data and target column.
-
-- **ds_statistics**:
-  - `test_kruskal_wallis`: Perform the Kruskal-Wallis statistical test.
-  - `test_agosto_pearsona`: Test for normality using D'Agostino-Pearson test.
-
-- **evaluate**:
-  - `ModelEvaluator`: Evaluate models and generate plots for diagnostics.
-  - `ShapExplainer`: Explain model predictions using SHAP values.
-
-- **experiments**:
-  - `VertexExperiment`: Manage experiments with Vertex AI.
-
-- **optuna**:
-  - `Optuna`: Optimize hyperparameters using Optuna.
-
-- **metrics**:
-  - `Metrics`: Calculate metrics for both classification and regression models.
-
-- **modeling**:
-  - `Modeling`: Manage modeling, metrics, and logging with Vertex AI.
-
-- **Supervised**:
-  - `LazyClassifier`: A classifier that automatically trains and evaluates multiple models.
-  - `LazyRegressor`: A regressor that automatically trains and evaluates multiple models.
-  - `get_card_split`: Function to split data into card-like groups.
-  - `adjusted_rsquared`: Calculate adjusted R-squared for regression models.
-
-- **visualization**:
-  - `MetricsPlot`: Compare metrics for different parameter values.
-  - `Radar`: Create radar plots for visualizing data.
-  - `cluster_characteristics`: Analyze cluster characteristics.
-  - `comparison_density`: Compare density distributions.
-  - `elbow_visualisation`: Visualize the elbow method for clustering.
-  - `describe_clusters_metrics`: Describe metrics for clusters.
-  - `category_null_variables`: Visualize null variables in categorical data.
-  - `normal_distr_plots`: Visualize normal distribution plots.
-  - `distplot_limitations`: Visualize limitations of distplot.
-  - `boxplot_limitations`: Visualize limitations of boxplot.
-  - `violinplot_limitations`: Visualize limitations of violinplot.
-  - `countplot_limitations`: Visualize limitations of countplot.
-  - `categorical_variable_perc`: Visualize percentage of categorical variables.
-  - `spearman_correlation`: Visualize spearman correlation.
-  - `calculate_crammers_v`: Calculate Crammer's V.
-
-- **what_if_streamlit**:
-  - `ShapSaver`: Save SHAP explainer components for lazy loading in what-if analysis.
-  - `ColumnMetadataGenerator`: Generate column metadata from a DataFrame or CSV file.
-
-- **monitoring**:
-  - `mapping`: Create column mapping from configuration file for Evidently.
-  - `test_data`: Test data for issues using Evidently test suites.
-  - `check_data_drift`: Check data for drift using Evidently metrics.
-  - `send_email_with_table`: Send email notifications with HTML tables for monitoring alerts.