Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Dref360 authored Mar 21, 2024
1 parent e2974dc commit ccea565
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,8 @@

This library provides an implementation of CSG, from CVPR 2019 paper: [Spectral Metric for Dataset Complexity Assessment](https://arxiv.org/abs/1905.07299).

**Installation**

`pip install spectral-metric`


CSG is a measure which estimates the complexity of a dataset by combining probability product kernel (Jebara et al.) and
Graph Theory. By doing so, one can estimate the complexity of their dataset without training a model.
> [!NOTE]
> CSG is a measure that estimates the complexity of a dataset by combining probability product kernel (Jebara et al.) and Graph Theory. By doing so, one can estimate the complexity of their dataset without training a model.
For the experiment part of the repo, please see [./experiments/README.md](./experiments/README.md)

Expand All @@ -27,7 +22,9 @@ For the experiment part of the repo, please see [./experiments/README.md](./expe
1. [🤗 HuggingFace Space](https://huggingface.co/spaces/Dref360/spectral-metric)
2. [In-depth analysis of CLINC-150](https://github.com/Dref360/spectral-metric/blob/master/notebooks/clinc_oos.ipynb)

![](./images/example.png)
**Installation**

`pip install spectral-metric`

## How to use

Expand All @@ -48,9 +45,9 @@ estimator.evals, estimator.evecs # The eigenvalues and vectors.
make_graph(estimator.difference, title="Your dataset", classes=["A", "B", "C"])
```

## Support

For support, please submit an issue!
<p align="center">
<img src="./images/example.png" width="50%">
</p>

# Results

Expand All @@ -63,12 +60,16 @@ higher the values are, the harder the dataset is.
**Note:** The actual CSG is based on the gradient of the eigenvalues,
this is done to overcome issues where the first classes are easy to separate, but not the last ones.

Please see the paper for more details.
Please refer to the paper for more details.

## Support

For support, please submit an issue!


# Contributing

We are open to contributions, simply submit an issue or a pull request.
We are open to contributions, please submit an issue or a pull request.

To get yourself a running environment you will need [Poetry](https://python-poetry.org/), our package manager.

Expand Down

0 comments on commit ccea565

Please sign in to comment.