Skip to content

Commit

Permalink
fix: addressed by peer review in issue 81 - (continuing from previous…
Browse files Browse the repository at this point in the history
… fix on the same issue): added link for repo status, python versions and ci/cd badges and text hyperlink to tutorial/documentation in README
  • Loading branch information
musiccabin committed Feb 1, 2025
1 parent 1bfddf2 commit a501a36
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# compare_classifiers
[![Documentation Status](https://readthedocs.org/projects/compare-classifiers-524/badge/?version=latest)](https://compare-classifiers-524.readthedocs.io/en/latest/?badge=latest)
![Repo Status](https://img.shields.io/badge/repo%20status-Active-brightgreen)
![Python Versions](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)
![CI/CD](https://github.com/UBC-MDS/compare_classifiers/actions/workflows/ci-cd.yml/badge.svg)
[![Repo Status](https://img.shields.io/badge/repo%20status-Active-brightgreen)](https://github.com/UBC-MDS/compare_classifiers)
[![Python Versions](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
[![CI/CD](https://github.com/UBC-MDS/compare_classifiers/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/UBC-MDS/compare_classifiers/actions)
[![codecov](https://codecov.io/gh/UBC-MDS/compare_classifiers/graph/badge.svg?token=Divjf41jU3)](https://codecov.io/gh/UBC-MDS/compare_classifiers)

Compare metrics such as f1 score and confusion matrices for your machine learning models and through voting or stacking them, then predict on test data with your choice of voting or stacking!
Expand Down Expand Up @@ -38,8 +38,7 @@ We have attached a downloaded version of the [UCI Wine Quality dataset](https://

## Usage

`compare_classifiers` can be used to show confusion matrices and f1 scores for individual estimators, as well as f1 score for voting or stacking the estimators,
as follows:
`compare_classifiers` can be used to show confusion matrices and f1 scores for individual estimators, as well as f1 score for voting or stacking the estimators. We made a [tutorial with detailed documentation](https://compare-classifiers-524.readthedocs.io/en/latest/example.html) and here is a brief overview of how to use the package:

### Step 1: Read in Data and Initial Processing

Expand Down

0 comments on commit a501a36

Please sign in to comment.