moreo
/
QuaPy
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

updating broken links to api doc in readme

This commit is contained in:
Alejandro Moreo Fernandez 2024-09-17 11:54:49 +02:00
parent a271fe1231
commit da6bb62470
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -14,7 +14,7 @@ for facilitating the analysis and interpretation of the experimental results.
### Last updates: ### Last updates:
* Version 0.1.9 is released! major changes can be consulted [here](CHANGE_LOG.txt). * 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 ### Installation
@ -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 should be tested across many samples, even ones characterized by class prevalence
values different or very different from those found in the training set. values different or very different from those found in the training set.
QuaPy implements sampling procedures and evaluation protocols that automate this workflow. 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 ## Features
@ -100,18 +101,18 @@ In case you want to contribute improvements to quapy, please generate pull reque
## Documentation ## 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: are provided:
* [Datasets](https://github.com/HLT-ISTI/QuaPy/wiki/Datasets) * [Datasets](https://hlt-isti.github.io/QuaPy/manuals/datasets.html)
* [Evaluation](https://github.com/HLT-ISTI/QuaPy/wiki/Evaluation) * [Evaluation](https://hlt-isti.github.io/QuaPy/manuals/evaluation.html)
* [Protocols](https://github.com/HLT-ISTI/QuaPy/wiki/Protocols) * [Explicit loss minimization](https://hlt-isti.github.io/QuaPy/manuals/explicit-loss-minimization.html)
* [Methods](https://github.com/HLT-ISTI/QuaPy/wiki/Methods) * [Methods](https://hlt-isti.github.io/QuaPy/manuals/methods.html)
* [SVMperf](https://github.com/HLT-ISTI/QuaPy/wiki/ExplicitLossMinimization) * [Model Selection](https://hlt-isti.github.io/QuaPy/manuals/datasets.html)
* [Model Selection](https://github.com/HLT-ISTI/QuaPy/wiki/Model-Selection) * [Plotting](https://hlt-isti.github.io/QuaPy/manuals/plotting.html)
* [Plotting](https://github.com/HLT-ISTI/QuaPy/wiki/Plotting) * [Protocols](https://hlt-isti.github.io/QuaPy/manuals/protocols.html)
## Acknowledgments: ## Acknowledgments:

2
setup.py
View File

@ -160,7 +160,7 @@ setup(
'Contributors': 'https://github.com/HLT-ISTI/QuaPy/graphs/contributors', 'Contributors': 'https://github.com/HLT-ISTI/QuaPy/graphs/contributors',
'Bug Reports': 'https://github.com/HLT-ISTI/QuaPy/issues', 'Bug Reports': 'https://github.com/HLT-ISTI/QuaPy/issues',
'Wiki': 'https://github.com/HLT-ISTI/QuaPy/wiki', '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/', 'Source': 'https://github.com/HLT-ISTI/QuaPy/',
}, },
) )