Skip to content

Commit

Permalink
added supplementary demos
Browse files Browse the repository at this point in the history
  • Loading branch information
emsimons committed Dec 3, 2024
1 parent 86a8a17 commit 2483a06
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Core functionalities of `Diversipy` for a list of metric spaces include:
- Computing **magnitude functions** across varying distance scales
- Calculating **MagArea**: the area under a magnitude function, a multi-scale measure of the **intrinsic diversity** of a space
- Calculating **MagDiff**: the area between two magnitude functions to measure the **difference in diversity** between two spaces
- Detecting **mode dropping** and **mode collapse** in generative models


### 2. `Magnipy`: For in-depth magnitude computations on a single metric space.
Expand All @@ -51,10 +50,16 @@ Core functionalities of `Magnipy` for an individual metric space include:

## Tutorials

Separate tutorials for the `Diversipy` and `Magnipy` classes can be found under the `notebooks` folder (`diversipy_tutorial.ipynb` and `magnipy_tutorial.ipynb` respectively), and are aided by the `tutorial_data.py` script.
Separate tutorials for the Diversipy and Magnipy classes can be found under the `notebooks` folder (`diversipy_tutorial.ipynb` and `magnipy_tutorial.ipynb` respectively), and are aided by the `tutorial_data.py` script.

Each tutorial demonstrates how to initialize and utiltize its corresponding class to execute core functionalities.

### Supplementary Demos

The following supplementary demos are also provided:
- Using MagDiff as a metric for **detecting mode dropping / mode collapse** (`notebooks/mode_dropping.ipynb`).
- (Coming soon...) Using Magnipy to calculate the **magnitude dimension** of a metric space

# Citation
Please consider citing our work!

Expand Down

0 comments on commit 2483a06

Please sign in to comment.