Skip to content

Commit

Permalink
Added module structure to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@out-somniac
out-somniac committed May 20, 2024
1 parent 159bb59 commit 0ab45b7
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ This library contains implementation of algorithms adapted from the following me

In addition this library contains tools for visualisation and running tests and comparisons on the `iris` dataset.

## Structure
The `model` module contains all the implementations of algorithms and metrics as well as the solution representation structs.
The `plot` module contains all the utility functions required for visualising crossections of the dataset and the results of our implementations.
The `utility` module contains normalization functions and other generic utility functions.

## Build instructions
Simply run `cargo build --release`. 🦀😎

Expand Down

0 comments on commit 0ab45b7

Please sign in to comment.