Skip to content

Commit

Permalink
Another docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
SkBlaz committed Sep 17, 2023
1 parent 940575a commit 0eff149
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Minimal examples and an interface to explore OutRank's functionality are availab

# Contributing
1. Make sure the functionality is not already implemented!
2. Decide whether where the functionality would fit best (is it an algorithm? A parser?)
3. Open a PR with rationale
2. Decide where the functionality would fit best (is it an algorithm? A parser?)
3. Open a PR with the implementation

# Bugs and other reports
Feel free to open a PR that contains:
Expand Down
2 changes: 1 addition & 1 deletion docs/DOCSMAIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ featureA featureC 0.125
```


# Use and installation - first steps (OutRank as a CLI)
# Innstallation
```bash
pip install outrank
```
Expand Down
4 changes: 2 additions & 2 deletions docs/outrank.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<h2>Contents</h2>
<ul>
<li><a href="#welcome-to-outranks-documentation">Welcome to OutRank's documentation!</a></li>
<li><a href="#use-and-installation-first-steps-outrank-as-a-cli">Use and installation - first steps (OutRank as a CLI)</a></li>
<li><a href="#innstallation">Innstallation</a></li>
<li><a href="#example-use-cases">Example use cases</a></li>
</ul>

Expand Down Expand Up @@ -69,7 +69,7 @@ <h1 class="modulename">
featureA featureC 0.125
</code></pre>

<h1 id="use-and-installation-first-steps-outrank-as-a-cli">Use and installation - first steps (OutRank as a CLI)</h1>
<h1 id="innstallation">Innstallation</h1>

<div class="pdoc-code codehilite">
<pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>outrank
Expand Down
2 changes: 1 addition & 1 deletion docs/search.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion examples/run_ranking_combinations.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ outrank \
--data_source csv-raw \
--heuristic MI-numba-randomized \
--target_ranking_only True \
--interaction_order 2 \
--interaction_order 3 \
--combination_number_upper_bound 2048 \
--num_threads 50 \
--output_folder ./some_output_folder_triplets \
Expand Down

0 comments on commit 0eff149

Please sign in to comment.