From f453daa3d46865ff7ae15824d6c8c35ae6aba27b Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 13:32:16 +0200 Subject: [PATCH 1/7] links updated, reformatting --- docs/development.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/docs/development.md b/docs/development.md index 0be3b97..c2cedd6 100644 --- a/docs/development.md +++ b/docs/development.md @@ -3,20 +3,11 @@ Thank you for considering contributing to our Python package! We appreciate your time and effort in helping us improve our project. Please take a moment to review the following guidelines to ensure a smooth and efficient contribution process. -## Table of Contents - -- Code of Conduct -- Setting Up Development Environment -- How to Contribute -- Submitting Contributions -- Issue Tracker -- License - -### Code of Conduct +## Code of Conduct We kindly request all contributors to adhere to our Code of Conduct when participating in this project. It outlines our expectations for respectful and inclusive behavior within the community. -### Setting Up Development Environment +## Setting Up Development Environment To set up the development environment for this Python package, follow these steps: @@ -39,11 +30,11 @@ pip install -r docs/requirements_docs.txt **Note:** You can also set up a virtual environment to isolate your development environment. -### How to Contribute +## How to Contribute 1. Create a new branch from the `develop` branch for your contributions. Please use descriptive and concise branch names. 2. Make your desired changes or additions to the codebase. -3. Ensure that your code adheres to our coding style guidelines. +3. Ensure that your code adheres to [PEP8](https://peps.python.org/pep-0008/) coding style guidelines. 4. Write appropriate tests for your changes, ensuring that they pass. - `make test` 5. Update the documentation and examples, if necessary. @@ -58,7 +49,7 @@ pip install -r docs/requirements_docs.txt 10. Wait for the maintainers to review your pull request. Address any feedback or comments if required. 11. Once approved, your changes will be merged into the main codebase. -### Submitting Contributions +## Submitting Contributions When submitting your contributions, please ensure the following: @@ -69,11 +60,11 @@ When submitting your contributions, please ensure the following: - Update the documentation if necessary to reflect the changes made. - Ensure that your pull request has a single, logical focus. -### Issue Tracker +## Issue Tracker If you encounter any bugs, have feature requests, or need assistance, please visit our [Issue Tracker](https://github.com/basf/mamba-tabular/issues). Make sure to search for existing issues before creating a new one. -### License +## License By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project. Please note that the above guidelines are subject to change, and the project maintainers hold the right to reject or request modifications to any contributions. Thank you for your understanding and support in making this project better! From 2774b6342c2cab81ead820ed17ee66ae1d439eb1 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 13:53:57 +0200 Subject: [PATCH 2/7] updated guidelines --- docs/release.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/release.md b/docs/release.md index bcba3cf..71f6eac 100644 --- a/docs/release.md +++ b/docs/release.md @@ -2,5 +2,46 @@ The document outlines the steps to build and release the `mambular` package. At this point, it is assumed that the development and testing of the package have been completed successfully. +## 1. Test documentation +It is expected from the contributor to update the documentation as an when required along side the change in source code. Please use the below process to test the documentation: + +```sh +cd mambular/docs/ + +make doctest +``` +Fix any docstring related issue, then proceed with next steps. + +## 2. Version update +The package version is mantained in `mambular/__version__.py` file. Increment the version according to the changes such as patch, minor, major or all. + +## 3. Release +We use git flow for the package release. + +```sh +git flow release start +``` +- A new branch is created from the `develop` branch. This new branch is named according to the convention `release/`. For example, if you run `git flow release start 1.0.0`, the new branch will be `release/1.0.0`. +- The current working branch switches to the newly created release branch. This means any new commits will be added to the release branch, not the `develop` branch. +- This new branch is used to finalize the release. You can perform tasks such as version number bumps, documentation updates, and final testing. + +Once you are satisfied with changes, use the below command to finish the release. +```sh + git flow release finish +``` + +- It will Merges the release branch into `main` (or `master`). +- Tags the release with the version number. +- Merges the release branch back into `develop`. +- Deletes the release branch. + +Finally, push the commits and tags to origin. + +```sh +git push origin --tags +``` + + + From fc15d571e5f002649855f04b9d6e5ad96f9236d0 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 13:55:50 +0200 Subject: [PATCH 3/7] minor text update --- docs/installation.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index d3e36df..30a1cd6 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,8 +1,8 @@ # Installation -Please follow the steps below for installing `mambular` +Please follow the steps below for installing `mambular`. -Install from the source: +## Install from the source: ```bash cd mamba-tabular @@ -11,4 +11,6 @@ pip install . Note: Make sure you in the same directory where `setup.py` file resides. -This package is so far not available in PyPi. +## Installation from PyPi: + +**Note:**This package is so far not available in PyPi, expected to release soon! From 4d5c75198c0d0ead7a07c94e54ebc780803cfe8f Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 13:58:30 +0200 Subject: [PATCH 4/7] module renamed --- docs/api/base_models/BaseModels.rst | 4 ++-- docs/api/models/Models.rst | 4 ++-- docs/api/utils/Preprocessor.rst | 4 ++-- docs/index.rst | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api/base_models/BaseModels.rst b/docs/api/base_models/BaseModels.rst index 2e4b3ec..40ed26a 100644 --- a/docs/api/base_models/BaseModels.rst +++ b/docs/api/base_models/BaseModels.rst @@ -1,5 +1,5 @@ -Base Models -=========== +mambular.base_models +==================== .. autoclass:: mambular.base_models.BaseMambularClassifier :members: diff --git a/docs/api/models/Models.rst b/docs/api/models/Models.rst index 02a0bd3..583fa95 100644 --- a/docs/api/models/Models.rst +++ b/docs/api/models/Models.rst @@ -1,5 +1,5 @@ -Models -====== +mambular.models +=============== .. autoclass:: mambular.models.MambularClassifier :members: diff --git a/docs/api/utils/Preprocessor.rst b/docs/api/utils/Preprocessor.rst index 60f5706..1cc8f33 100644 --- a/docs/api/utils/Preprocessor.rst +++ b/docs/api/utils/Preprocessor.rst @@ -1,5 +1,5 @@ -Preprocessing -============= +mambular.utils +============== .. autoclass:: mambular.utils.Preprocessor :members: diff --git a/docs/index.rst b/docs/index.rst index 8432b8d..8f92547 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,9 +30,9 @@ :maxdepth: 2 :hidden: - api/models/Models - api/base_models/BaseModels - api/utils/Preprocessor + api/models/index + api/base_models/index + api/utils/index .. toctree:: From 004b633a3a479a74a54530c2910c2ff40e51f830 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 14:01:54 +0200 Subject: [PATCH 5/7] reformatting --- docs/development.md | 12 ++++++------ docs/installation.md | 4 ++-- docs/release.md | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/development.md b/docs/development.md index c2cedd6..261aafe 100644 --- a/docs/development.md +++ b/docs/development.md @@ -3,11 +3,11 @@ Thank you for considering contributing to our Python package! We appreciate your time and effort in helping us improve our project. Please take a moment to review the following guidelines to ensure a smooth and efficient contribution process. -## Code of Conduct +### Code of Conduct We kindly request all contributors to adhere to our Code of Conduct when participating in this project. It outlines our expectations for respectful and inclusive behavior within the community. -## Setting Up Development Environment +### Setting Up Development Environment To set up the development environment for this Python package, follow these steps: @@ -30,7 +30,7 @@ pip install -r docs/requirements_docs.txt **Note:** You can also set up a virtual environment to isolate your development environment. -## How to Contribute +### How to Contribute 1. Create a new branch from the `develop` branch for your contributions. Please use descriptive and concise branch names. 2. Make your desired changes or additions to the codebase. @@ -49,7 +49,7 @@ pip install -r docs/requirements_docs.txt 10. Wait for the maintainers to review your pull request. Address any feedback or comments if required. 11. Once approved, your changes will be merged into the main codebase. -## Submitting Contributions +### Submitting Contributions When submitting your contributions, please ensure the following: @@ -60,11 +60,11 @@ When submitting your contributions, please ensure the following: - Update the documentation if necessary to reflect the changes made. - Ensure that your pull request has a single, logical focus. -## Issue Tracker +### Issue Tracker If you encounter any bugs, have feature requests, or need assistance, please visit our [Issue Tracker](https://github.com/basf/mamba-tabular/issues). Make sure to search for existing issues before creating a new one. -## License +### License By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project. Please note that the above guidelines are subject to change, and the project maintainers hold the right to reject or request modifications to any contributions. Thank you for your understanding and support in making this project better! diff --git a/docs/installation.md b/docs/installation.md index 30a1cd6..709d27c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,7 +2,7 @@ Please follow the steps below for installing `mambular`. -## Install from the source: +### Install from the source: ```bash cd mamba-tabular @@ -11,6 +11,6 @@ pip install . Note: Make sure you in the same directory where `setup.py` file resides. -## Installation from PyPi: +### Installation from PyPi: **Note:**This package is so far not available in PyPi, expected to release soon! diff --git a/docs/release.md b/docs/release.md index 71f6eac..b8a370b 100644 --- a/docs/release.md +++ b/docs/release.md @@ -2,7 +2,7 @@ The document outlines the steps to build and release the `mambular` package. At this point, it is assumed that the development and testing of the package have been completed successfully. -## 1. Test documentation +### 1. Test documentation It is expected from the contributor to update the documentation as an when required along side the change in source code. Please use the below process to test the documentation: ```sh @@ -12,10 +12,10 @@ make doctest ``` Fix any docstring related issue, then proceed with next steps. -## 2. Version update +### 2. Version update The package version is mantained in `mambular/__version__.py` file. Increment the version according to the changes such as patch, minor, major or all. -## 3. Release +### 3. Release We use git flow for the package release. ```sh From 91da92296d228315d7d01f33bbceef05dc3a6f4f Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 14:07:44 +0200 Subject: [PATCH 6/7] reformatting --- docs/development.md | 2 +- docs/installation.md | 2 +- docs/release.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/development.md b/docs/development.md index 261aafe..884c046 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,5 +1,5 @@ -# Contribute +## Contribute Thank you for considering contributing to our Python package! We appreciate your time and effort in helping us improve our project. Please take a moment to review the following guidelines to ensure a smooth and efficient contribution process. diff --git a/docs/installation.md b/docs/installation.md index 709d27c..e808a43 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,4 +1,4 @@ -# Installation +## Installation Please follow the steps below for installing `mambular`. diff --git a/docs/release.md b/docs/release.md index b8a370b..a083c01 100644 --- a/docs/release.md +++ b/docs/release.md @@ -1,4 +1,4 @@ -# Build and release +## Build and release The document outlines the steps to build and release the `mambular` package. At this point, it is assumed that the development and testing of the package have been completed successfully. From b11cd4dbc687f4e6d71455fc6eedd266668ac022 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Tue, 28 May 2024 14:07:51 +0200 Subject: [PATCH 7/7] doctest fix --- mambular/models/sklearn_classifier.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/mambular/models/sklearn_classifier.py b/mambular/models/sklearn_classifier.py index dbfce8a..5264680 100644 --- a/mambular/models/sklearn_classifier.py +++ b/mambular/models/sklearn_classifier.py @@ -517,11 +517,11 @@ def predict_proba(self, X): >>> from sklearn.metrics import accuracy_score, precision_score, f1_score, roc_auc_score >>> # Define the metrics you want to evaluate >>> metrics = { - 'Accuracy': (accuracy_score, False), - 'Precision': (precision_score, False), - 'F1 Score': (f1_score, False), - 'AUC Score': (roc_auc_score, True) - } + ... 'Accuracy': (accuracy_score, False), + ... 'Precision': (precision_score, False), + ... 'F1 Score': (f1_score, False), + ... 'AUC Score': (roc_auc_score, True) + ... } >>> # Assuming 'X_test' and 'y_test' are your test dataset and labels >>> # Evaluate using the specified metrics >>> results = classifier.evaluate(X_test, y_test, metrics=metrics)