Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SkBlaz committed Sep 17, 2023
1 parent 718132f commit 283eb87
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions DOCS.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,17 @@

░█████╗░██╗░░░██╗████████╗██████╗░░█████╗░███╗░░██╗██╗░░██╗
██╔══██╗██║░░░██║╚══██╔══╝██╔══██╗██╔══██╗████╗░██║██║░██╔╝
██║░░██║██║░░░██║░░░██║░░░██████╔╝███████║██╔██╗██║█████═╝░
██║░░██║██║░░░██║░░░██║░░░██╔══██╗██╔══██║██║╚████║██╔═██╗░
╚█████╔╝╚██████╔╝░░░██║░░░██║░░██║██║░░██║██║░╚███║██║░╚██╗
░╚════╝░░╚═════╝░░░░╚═╝░░░╚═╝░░╚═╝╚═╝░░╚═╝╚═╝░░╚══╝╚═╝░░╚═╝


# Welcome to OutRank's documentation!

All functions/methods can be searched-for (search bar on the left).

This tool enables fast screening of feature-feature interactions. Its purpose is to give the user fast insight into potential redundancies/anomalies in the data.
It is implemented to operate in _mini batches_, it traverses the `raw data` incrementally, refining the rankings as it goes along.
The interaction ranking outputs triplets which look as follows:
It is implemented to operate in _mini batches_, it traverses the `raw data` incrementally, refining the rankings as it goes along. The core operation, interaction ranking, outputs triplets which look as follows:

```
featureA featureB 0.512
featureA featureC 0.125
```


# Use and installation - CLI
# Use and installation - first steps (OutRank as a CLI)
```bash
pip install outrank
```
Expand All @@ -38,4 +28,8 @@ if this passes, you can be pretty certain OutRank will perform as intended. OutR
outrank --help
```

A minimal showcase of performing feature ranking on a generic CSV is demonstrated with [this example](../scripts/run_minimal.sh)

# Example use cases
* A minimal showcase of performing feature ranking on a generic CSV is demonstrated with [this example](../scripts/run_minimal.sh)

* [More examples](../scripts/) demonstrating OutRank's capabilities are also available.

0 comments on commit 283eb87

Please sign in to comment.