pycalib


Namepycalib JSON
Version 0.0.9.dev6 PyPI version JSON
download
home_pagehttps://www.perellonieto.com/PyCalib/index.html
SummaryPython library with tools for classifier calibration.
upload_time2021-05-18 14:42:43
maintainer
docs_urlNone
authorMiquel Perello Nieto, Hao Song, Telmo de Menezes e Silva Filho
requires_python
license
keywords classifier calibration calibration classification
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![CI][ci:b]][ci]
[![Documentation][documentation:b]][documentation]
[![License BSD3][license:b]][license]
![Python3.8][python:b]
[![pypi][pypi:b]][pypi]
[![codecov][codecov:b]][codecov]

[ci]: https://github.com/perellonieto/PyCalib/actions/workflows/ci.yml
[ci:b]: https://github.com/perellonieto/pycalib/workflows/CI/badge.svg
[documentation]: https://github.com/perellonieto/PyCalib/actions/workflows/documentation.yml
[documentation:b]: https://github.com/perellonieto/pycalib/workflows/Documentation/badge.svg
[license]: https://github.com/perellonieto/PyCalib/blob/master/LICENSE.txt
[license:b]: https://img.shields.io/github/license/perellonieto/pycalib.svg
[python:b]: https://img.shields.io/badge/python-3.8-blue
[pypi]: https://badge.fury.io/py/pycalib
[pypi:b]: https://badge.fury.io/py/pycalib.svg
[codecov]: https://codecov.io/gh/perellonieto/PyCalib
[codecov:b]: https://codecov.io/gh/perellonieto/PyCalib/branch/master/graph/badge.svg?token=AYMZPLELT3

PyCalib
=======
Python library for classifier calibration

User installation
-----------------

The PyCalib package can be installed from Pypi with the command

```
pip install pycalib
```

Documentation
-------------

The documentation can be found at https://www.perellonieto.com/PyCalib/

Development
===========

There is a make file to automate some of the common tasks during development.
After downloading the repository create the virtual environment with the
command

```
make venv
```

This will create a `venv` folder in your current folder. The environment needs
to be loaded out of the makefile with

```
source venv/bin/activate
```

After the environment is loaded, all dependencies can be installed with

```
make requirements-dev
```

Unittest
--------

Unittests are specified as doctest examples in simple functions (see example ),
and more complex tests in their own python files starting with `test_` (see
example ).

Run the unittest with the command

```
make test
```

The test will show a unittest result including the coverage of the code.
Ideally we want to increase the coverage to cover most of the library.

Contiunous Integration
----------------------

Every time a commit is pushed to the master branch a unittest is run following
the workflow [.github/workflows/ci.yml](.github/workflows/ci.yml). The CI badge
in the README file will show if the test has passed or not.

Analyse code
------------

We are trying to follow the same code standards as in [Numpy][numpy:c] and 
[Scikit-learn][sklearn:c], it is possible to check for pep8 and other code
conventions with

[numpy:c]: https://numpy.org/devdocs/dev/index.html
[sklearn:c]: https://scikit-learn.org/stable/developers/index.html

```
make code-analysis
```

Documentation
-------------

The documentation can be found at
[https://www.perellonieto.com/PyCalib/](https://www.perellonieto.com/PyCalib/),
and it is automatically updated after every push to the master branch.

All documentation is done ussing the [Sphinx documentation
generator][sphinx:l].  The documentation is written in
[reStructuredText][rst:l] (\*.rst) files in the `docs/source` folder. We try to
follow the conventions from [Numpy][numpy:d] and [Scikit-learn][sklearn:d].

[numpy:d]: https://numpydoc.readthedocs.io/en/latest/format.html
[sklearn:d]: https://scikit-learn.org/stable/developers/contributing.html#documentation

The examples with images in folder `docs/source/examples` are generated
automatically with [Sphinx-gallery][sphinx:g] from the python code in folder
[examples/](examples/) starting with `xmpl_{example_name}.py`.

[rst:l]: https://docutils.sourceforge.io/rst.html
[sphinx:l]: https://www.sphinx-doc.org/en/master/
[sphinx:g]: https://sphinx-gallery.github.io/stable/index.html

The docuemnation can be build with the command

```
make doc
```

(Keep in mind that the documentation has its own Makefile inside folder [docs](docs)).

After building the documentation, a new folder should appear in `docs/build/`
with an `index.html` that can be opened locally for further exploration.

The documentation is always build and deployed every time a new commit is
pushed to the master branch with the workflow
[.github/workflows/documentation.yml](.github/workflows/documentation.yml).

After building, the `docs/build/html` folder is pushed to the branch
[gh-pages][gh:l].

[gh:l]: https://github.com/perellonieto/PyCalib/tree/gh-pages

Check Readme
------------

It is possible to check that the README file passes some tests for Pypi by
running

```
make check-readme
```

Upload to PyPi
--------------

After testing that the code passes all unittests and upgrading the version in
the file `pycalib/__init__.py` the code can be published in Pypi with the
following command:

```
make pypi
```

It may require user and password if these are not set in your home directory a
file  __.pypirc__

```
[pypi]
username = __token__
password = pypi-yourtoken
```

Contributors
------------

This code has been adapted by Miquel from several previous codes. The following
is a list of people that has been involved in some parts of the code.

- Miquel Perello Nieto
- Hao Song
- Telmo Silva Filho
- Markus Kängsepp
            

Raw data

            {
    "_id": null,
    "home_page": "https://www.perellonieto.com/PyCalib/index.html",
    "name": "pycalib",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "classifier calibration,calibration,classification",
    "author": "Miquel Perello Nieto, Hao Song, Telmo de Menezes e Silva Filho",
    "author_email": "perello.nieto@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c4/33/f1926e478a61459176278d51b07eb69b05de7cad2eadebc6a73dd7511ba0/pycalib-0.0.9.dev6.tar.gz",
    "platform": "",
    "description": "[![CI][ci:b]][ci]\n[![Documentation][documentation:b]][documentation]\n[![License BSD3][license:b]][license]\n![Python3.8][python:b]\n[![pypi][pypi:b]][pypi]\n[![codecov][codecov:b]][codecov]\n\n[ci]: https://github.com/perellonieto/PyCalib/actions/workflows/ci.yml\n[ci:b]: https://github.com/perellonieto/pycalib/workflows/CI/badge.svg\n[documentation]: https://github.com/perellonieto/PyCalib/actions/workflows/documentation.yml\n[documentation:b]: https://github.com/perellonieto/pycalib/workflows/Documentation/badge.svg\n[license]: https://github.com/perellonieto/PyCalib/blob/master/LICENSE.txt\n[license:b]: https://img.shields.io/github/license/perellonieto/pycalib.svg\n[python:b]: https://img.shields.io/badge/python-3.8-blue\n[pypi]: https://badge.fury.io/py/pycalib\n[pypi:b]: https://badge.fury.io/py/pycalib.svg\n[codecov]: https://codecov.io/gh/perellonieto/PyCalib\n[codecov:b]: https://codecov.io/gh/perellonieto/PyCalib/branch/master/graph/badge.svg?token=AYMZPLELT3\n\nPyCalib\n=======\nPython library for classifier calibration\n\nUser installation\n-----------------\n\nThe PyCalib package can be installed from Pypi with the command\n\n```\npip install pycalib\n```\n\nDocumentation\n-------------\n\nThe documentation can be found at https://www.perellonieto.com/PyCalib/\n\nDevelopment\n===========\n\nThere is a make file to automate some of the common tasks during development.\nAfter downloading the repository create the virtual environment with the\ncommand\n\n```\nmake venv\n```\n\nThis will create a `venv` folder in your current folder. The environment needs\nto be loaded out of the makefile with\n\n```\nsource venv/bin/activate\n```\n\nAfter the environment is loaded, all dependencies can be installed with\n\n```\nmake requirements-dev\n```\n\nUnittest\n--------\n\nUnittests are specified as doctest examples in simple functions (see example ),\nand more complex tests in their own python files starting with `test_` (see\nexample ).\n\nRun the unittest with the command\n\n```\nmake test\n```\n\nThe test will show a unittest result including the coverage of the code.\nIdeally we want to increase the coverage to cover most of the library.\n\nContiunous Integration\n----------------------\n\nEvery time a commit is pushed to the master branch a unittest is run following\nthe workflow [.github/workflows/ci.yml](.github/workflows/ci.yml). The CI badge\nin the README file will show if the test has passed or not.\n\nAnalyse code\n------------\n\nWe are trying to follow the same code standards as in [Numpy][numpy:c] and \n[Scikit-learn][sklearn:c], it is possible to check for pep8 and other code\nconventions with\n\n[numpy:c]: https://numpy.org/devdocs/dev/index.html\n[sklearn:c]: https://scikit-learn.org/stable/developers/index.html\n\n```\nmake code-analysis\n```\n\nDocumentation\n-------------\n\nThe documentation can be found at\n[https://www.perellonieto.com/PyCalib/](https://www.perellonieto.com/PyCalib/),\nand it is automatically updated after every push to the master branch.\n\nAll documentation is done ussing the [Sphinx documentation\ngenerator][sphinx:l].  The documentation is written in\n[reStructuredText][rst:l] (\\*.rst) files in the `docs/source` folder. We try to\nfollow the conventions from [Numpy][numpy:d] and [Scikit-learn][sklearn:d].\n\n[numpy:d]: https://numpydoc.readthedocs.io/en/latest/format.html\n[sklearn:d]: https://scikit-learn.org/stable/developers/contributing.html#documentation\n\nThe examples with images in folder `docs/source/examples` are generated\nautomatically with [Sphinx-gallery][sphinx:g] from the python code in folder\n[examples/](examples/) starting with `xmpl_{example_name}.py`.\n\n[rst:l]: https://docutils.sourceforge.io/rst.html\n[sphinx:l]: https://www.sphinx-doc.org/en/master/\n[sphinx:g]: https://sphinx-gallery.github.io/stable/index.html\n\nThe docuemnation can be build with the command\n\n```\nmake doc\n```\n\n(Keep in mind that the documentation has its own Makefile inside folder [docs](docs)).\n\nAfter building the documentation, a new folder should appear in `docs/build/`\nwith an `index.html` that can be opened locally for further exploration.\n\nThe documentation is always build and deployed every time a new commit is\npushed to the master branch with the workflow\n[.github/workflows/documentation.yml](.github/workflows/documentation.yml).\n\nAfter building, the `docs/build/html` folder is pushed to the branch\n[gh-pages][gh:l].\n\n[gh:l]: https://github.com/perellonieto/PyCalib/tree/gh-pages\n\nCheck Readme\n------------\n\nIt is possible to check that the README file passes some tests for Pypi by\nrunning\n\n```\nmake check-readme\n```\n\nUpload to PyPi\n--------------\n\nAfter testing that the code passes all unittests and upgrading the version in\nthe file `pycalib/__init__.py` the code can be published in Pypi with the\nfollowing command:\n\n```\nmake pypi\n```\n\nIt may require user and password if these are not set in your home directory a\nfile  __.pypirc__\n\n```\n[pypi]\nusername = __token__\npassword = pypi-yourtoken\n```\n\nContributors\n------------\n\nThis code has been adapted by Miquel from several previous codes. The following\nis a list of people that has been involved in some parts of the code.\n\n- Miquel Perello Nieto\n- Hao Song\n- Telmo Silva Filho\n- Markus K\u00e4ngsepp",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python library with tools for classifier calibration.",
    "version": "0.0.9.dev6",
    "split_keywords": [
        "classifier calibration",
        "calibration",
        "classification"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "003285171290723faa93d9771befb709",
                "sha256": "9160759b135b7d3f86d6722963037e6f453013d3a1f94cc561e41b05b6c4e7ac"
            },
            "downloads": -1,
            "filename": "pycalib-0.0.9.dev6.tar.gz",
            "has_sig": false,
            "md5_digest": "003285171290723faa93d9771befb709",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30918,
            "upload_time": "2021-05-18T14:42:43",
            "upload_time_iso_8601": "2021-05-18T14:42:43.563405Z",
            "url": "https://files.pythonhosted.org/packages/c4/33/f1926e478a61459176278d51b07eb69b05de7cad2eadebc6a73dd7511ba0/pycalib-0.0.9.dev6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-05-18 14:42:43",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pycalib"
}
        
Elapsed time: 0.33925s