Skip to content

Commit

Permalink
updating broken links to api doc in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexMoreo committed Sep 17, 2024
1 parent a271fe1 commit da6bb62
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ for facilitating the analysis and interpretation of the experimental results.
### Last updates:

* Version 0.1.9 is released! major changes can be consulted [here](CHANGE_LOG.txt).
* The developer API documentation is available [here](https://hlt-isti.github.io/QuaPy/build/html/modules.html)
* The developer API documentation is available [here](https://hlt-isti.github.io/QuaPy/index.html)

### Installation

Expand Down Expand Up @@ -67,7 +67,8 @@ class prevalence of the training set. For this reason, any quantification model
should be tested across many samples, even ones characterized by class prevalence
values different or very different from those found in the training set.
QuaPy implements sampling procedures and evaluation protocols that automate this workflow.
See the [documentation](https://hlt-isti.github.io/QuaPy/build/html/) for detailed examples.
See the [documentation](https://hlt-isti.github.io/QuaPy/manuals/protocols.html)
and the [examples directory](https://github.com/HLT-ISTI/QuaPy/tree/master/examples) for detailed examples.

## Features

Expand Down Expand Up @@ -100,18 +101,18 @@ In case you want to contribute improvements to quapy, please generate pull reque

## Documentation

The [developer API documentation](https://hlt-isti.github.io/QuaPy/build/html/modules.html) is available [here](https://hlt-isti.github.io/QuaPy/build/html/index.html).
The developer API documentation is available [here](https://hlt-isti.github.io/QuaPy/).

Check out our [Wiki](https://github.com/HLT-ISTI/QuaPy/wiki), in which many examples
Check out our [Wiki](https://hlt-isti.github.io/QuaPy/manuals.html), in which many examples
are provided:

* [Datasets](https://github.com/HLT-ISTI/QuaPy/wiki/Datasets)
* [Evaluation](https://github.com/HLT-ISTI/QuaPy/wiki/Evaluation)
* [Protocols](https://github.com/HLT-ISTI/QuaPy/wiki/Protocols)
* [Methods](https://github.com/HLT-ISTI/QuaPy/wiki/Methods)
* [SVMperf](https://github.com/HLT-ISTI/QuaPy/wiki/ExplicitLossMinimization)
* [Model Selection](https://github.com/HLT-ISTI/QuaPy/wiki/Model-Selection)
* [Plotting](https://github.com/HLT-ISTI/QuaPy/wiki/Plotting)
* [Datasets](https://hlt-isti.github.io/QuaPy/manuals/datasets.html)
* [Evaluation](https://hlt-isti.github.io/QuaPy/manuals/evaluation.html)
* [Explicit loss minimization](https://hlt-isti.github.io/QuaPy/manuals/explicit-loss-minimization.html)
* [Methods](https://hlt-isti.github.io/QuaPy/manuals/methods.html)
* [Model Selection](https://hlt-isti.github.io/QuaPy/manuals/datasets.html)
* [Plotting](https://hlt-isti.github.io/QuaPy/manuals/plotting.html)
* [Protocols](https://hlt-isti.github.io/QuaPy/manuals/protocols.html)

## Acknowledgments:

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def get_version(rel_path):
'Contributors': 'https://github.com/HLT-ISTI/QuaPy/graphs/contributors',
'Bug Reports': 'https://github.com/HLT-ISTI/QuaPy/issues',
'Wiki': 'https://github.com/HLT-ISTI/QuaPy/wiki',
'Documentation': 'https://hlt-isti.github.io/QuaPy/build/html/index.html',
'Documentation': 'https://hlt-isti.github.io/QuaPy/',
'Source': 'https://github.com/HLT-ISTI/QuaPy/',
},
)

0 comments on commit da6bb62

Please sign in to comment.