Skip to content

Commit

Permalink
updated readme verbiage, citation for accuracy and readability
Browse files Browse the repository at this point in the history
  • Loading branch information
lshpaner committed Aug 26, 2024
1 parent 1651a7a commit c61ce50
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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},
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c61ce50

Please sign in to comment.