diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..85d0dd1 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,33 @@ +name: CI + +on: + pull_request: + push: + branches: + - main + - devel + +jobs: + + # take out unit tests + test: + name: Unit tests (Python ${{ matrix.python-version }}) + runs-on: ubuntu-latest + strategy: + matrix: + python-version: + - "3.11" + env: + QUAPY_TESTS_OMIT_LARGE_DATASETS: True + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip setuptools wheel + python -m pip install -e .[bayes,composable,tests] + - name: Test with unittest + run: python -m unittest diff --git a/CHANGE_LOG.txt b/CHANGE_LOG.txt index e218b10..b5e4f74 100644 --- a/CHANGE_LOG.txt +++ b/CHANGE_LOG.txt @@ -1,10 +1,21 @@ Change Log 0.1.9 ---------------- +- Moved the wiki documents to the ./docs/ folder so that they become editable via PR for the community + +- Added Composable methods from Mirko Bunse's qunfold library! (thanks to Mirko Bunse!) + +- Added Continuous Integration with GitHub Actions (thanks to Mirko Bunse!) - Added Bayesian CC method (thanks to Pawel Czyz!). The method is described in detail in the paper Ziegler, Albert, and Paweł Czyż. "Bayesian Quantification with Black-Box Estimators." arXiv preprint arXiv:2302.09159 (2023). +- Removed binary UCI datasets {acute.a, acute.b, balance.2} from the list qp.data.datasets.UCI_BINARY_DATASETS + (the datasets are still loadable from the fetch_UCIBinaryLabelledCollection and fetch_UCIBinaryDataset + functions, though). The reason is that these datasets tend to yield results (for all methods) that are + one or two orders of magnitude greater than for other datasets, and this has a disproportionate impact in + methods average (I suspect there is something wrong in those datasets). + Change Log 0.1.8 ---------------- diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..bb42adc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,7 +14,20 @@ help: .PHONY: help Makefile +# Convert Markdown files to reStructuredText before building HTML +markdown_to_rst: + @echo "Converting Markdown files to reStructuredText" + @mkdir -p $(SOURCEDIR)/wiki/wiki_examples/selected_plots + @cp $(SOURCEDIR)/wiki_editable/wiki_examples/selected_plots/* $(SOURCEDIR)/wiki/wiki_examples/selected_plots/ + @find $(SOURCEDIR)/wiki_editable -name '*.md' -exec sh -c 'pandoc -f markdown -t rst "$$1" -o "$(SOURCEDIR)/wiki/$$(basename "$$1" .md).rst"' _ {} \; + @echo "Conversion complete." + # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile +html: markdown_to_rst @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +# # Catch-all target: route all unknown targets to Sphinx using the new +# # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +# %: Makefile +# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index cc5b4dc..a4150cd 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -21,6 +21,23 @@ GitHub QuaPy is hosted in GitHub at `https://github.com/HLT-ISTI/QuaPy `_ +Wiki Documents +------------ + +In this section you can find useful information concerning different aspects of QuaPy, with examples: + +.. toctree:: + :maxdepth: 1 + + wiki/Datasets + wiki/Evaluation + wiki/ExplicitLossMinimization + wiki/Methods + wiki/Model-Selection + wiki/Plotting + wiki/Protocols + + .. toctree:: :maxdepth: 2 :caption: Contents: diff --git a/docs/build/html/_sources/quapy.method.rst.txt b/docs/build/html/_sources/quapy.method.rst.txt index 8026e0a..31a357a 100644 --- a/docs/build/html/_sources/quapy.method.rst.txt +++ b/docs/build/html/_sources/quapy.method.rst.txt @@ -52,6 +52,14 @@ quapy.method.non\_aggregative module :undoc-members: :show-inheritance: +quapy.method.composable module +------------------------ + +.. automodule:: quapy.method.composable + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 0099e44..7dcd630 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -43,6 +43,15 @@