From c61ce50bf9e050723692047e361e2c19386cdd88 Mon Sep 17 00:00:00 2001 From: lshpaner Date: Mon, 26 Aug 2024 14:41:13 -0700 Subject: [PATCH] updated readme verbiage, citation for accuracy and readability --- README.md | 6 +++--- setup.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0154ef9..620e714 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![Downloads](https://pepy.tech/badge/model_tuner)](https://pepy.tech/project/model_tuner) [![PyPI](https://img.shields.io/pypi/v/model_tuner.svg)](https://pypi.org/project/model_tuner/) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12727322.svg)](https://doi.org/10.5281/zenodo.12727322) -The `model_tuner` class is a versatile and powerful tool designed to facilitate the training, evaluation, and tuning of machine learning models. It supports various functionalities such as handling imbalanced data, applying different scaling and imputation techniques, calibrating models, and conducting cross-validation. This class is particularly useful for model selection and hyperparameter tuning, ensuring optimal performance across different metrics. +The `model_tuner` library is a versatile and powerful tool designed to facilitate the training, evaluation, and tuning of machine learning models. It supports various functionalities such as handling imbalanced data, applying different scaling and imputation techniques, calibrating models, and conducting cross-validation. This library is particularly useful for model selection, hyperparameter tuning, and ensuring optimal performance across different metrics. ## Prerequisites @@ -56,7 +56,7 @@ If you use `model_tuner` in your research or projects, please consider citing it ```bibtex @software{funnell_2024_12727322, - author = {Funnell, Arthur, + author = {Funnell, Arthur and Shpaner, Leonid and Petousis, Panayiotis}, title = {Model Tuner}, @@ -72,7 +72,7 @@ If you use `model_tuner` in your research or projects, please consider citing it ## Support -If you have any questions or issues with `model_tuner`, please open an issue on this GitHub repository. +If you have any questions or issues with `model_tuner`, please open an issue on this [GitHub repository](https://github.com/uclamii/model_tuner/). ## Acknowledgements diff --git a/setup.py b/setup.py index 30fdc11..6dd70b9 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ version="0.0.13a", author="UCLA CTSI ML Team: Leonid Shpaner, Arthur Funnell, Panayiotis Petousis", author_email="pp89@ucla.edu", - description="A Python library for tuning Machine Learning models.", + description="A Python library for tuning machine learning models.", long_description=open("README.md").read(), long_description_content_type="text/markdown", # Type of the long description package_dir={"": "src"}, # Directory where your package files are located