Skip to content
A high performance topological machine learning toolbox in Python
C++ Python Other
Branch: master
Clone or download

Latest commit

gtauzin and ulupo Correct and document utils/validate_params (#333)
* Correct validate_params and doc

Signed-off-by: Guillaume Tauzin <guillaume.tauzin@epfl.ch>

* Fix _hyperparameters

Signed-off-by: Guillaume Tauzin <guillaume.tauzin@epfl.ch>

* Fix typo

* Minor wording fixes

* Fix some grammar, use f-strings

* Fix linting

* Improve docstring for validate_params, linting

* Add forgotten "f"s in a ValueError string

* Add test and improve doc

Signed-off-by: Guillaume Tauzin <guillaume.tauzin@epfl.ch>

* Fix linting

Signed-off-by: Guillaume Tauzin <guillaume.tauzin@epfl.ch>

* Fix doc inconsistensies

Signed-off-by: Guillaume Tauzin <guillaume.tauzin@epfl.ch>

Co-authored-by: Umberto Lupo <46537483+ulupo@users.noreply.github.com>
Latest commit 6e2e205 Feb 27, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.azure-ci Run auditwheel repair for manylinux2010 wheels (#312) Feb 20, 2020
.tools Hide azure-ci and tools folders Jan 23, 2020
doc Creates point_clouds submodule and update doc/index.rst (#331) Feb 27, 2020
examples Avoid using plotting.py in mapper_quickstart Feb 26, 2020
gtda Correct and document utils/validate_params (#333) Feb 27, 2020
.coveragerc Rename library to giotto-tda (#198) Jan 21, 2020
.gitignore Rename library to giotto-tda (#198) Jan 21, 2020
.gitmodules Rename library to giotto-tda (#198) Jan 21, 2020
CMakeLists.txt Move bindings modules (#304) Feb 20, 2020
CODE_AUTHORS Glossary: cubical complex entry (#257) Feb 12, 2020
CODE_OF_CONDUCT.rst Update CODE_OF_CONDUCT.rst (#64) Oct 25, 2019
CODE_OWNERS Rename library to giotto-tda (#198) Jan 21, 2020
CONTRIBUTING.rst Hide azure-ci and tools folders Jan 23, 2020
DEED_OF_CONTRIBUTION.rst Documents rst (#17) (#20) Oct 18, 2019
GOVERNANCE.rst Rename library to giotto-tda (#198) Jan 21, 2020
ISSUE_TEMPLATE.md Rename library to giotto-tda (#198) Jan 21, 2020
LICENSE upgrade license for redistribution (#276) Feb 11, 2020
MANIFEST.in Update MANIFEST.in Oct 4, 2019
PULL_REQUEST_TEMPLATE.md Rename library to giotto-tda (#198) Jan 21, 2020
README.rst Bump joblib required version to 0.13 Feb 23, 2020
RELEASE.rst Credit Martino Milani in RELEASE.rst Jan 24, 2020
azure-pipelines.yml Run auditwheel repair for manylinux2010 wheels (#312) Feb 20, 2020
requirements.txt Bump joblib required version to 0.13 Feb 23, 2020
setup.cfg Remove python-igraph--specific steps from CI and README (#261) Feb 10, 2020
setup.py Replace string formatting with f-strings except in setup and validati… Feb 24, 2020

README.rst

Version Azure-build Azure-cov Azure-test Twitter-follow Slack-join

giotto-tda

giotto-tda is a high performance topological machine learning toolbox in Python built on top of scikit-learn and is distributed under the GNU AGPLv3 license. It is part of the Giotto family of open-source projects.

Project genesis

giotto-tda is the result of a collaborative effort between L2F SA, the Laboratory for Topology and Neuroscience at EPFL, and the Institute of Reconfigurable & Embedded Digital Systems (REDS) of HEIG-VD.

License

giotto-tda is distributed under the AGPLv3 license. If you need a different distribution license, please contact the L2F team at business@l2f.ch.

Documentation

Getting started

To get started with giotto-tda, first follow the installations steps below. This blog post, and references therein, offer a friendly introduction to the topic of topological machine learning and to the philosophy behind giotto-tda.

Tutorials and use cases

Simple tutorials can be found in the examples folder. For a wide selection of use cases and application domains, you can visit this page.

Installation

Dependencies

The latest stable version of giotto-tda requires:

  • Python (>= 3.6)
  • NumPy (>= 1.17.0)
  • SciPy (>= 0.17.0)
  • joblib (>= 0.13)
  • scikit-learn (>= 0.22.0)
  • python-igraph (>= 0.7.1.post6)
  • matplotlib (>= 3.0.3)
  • plotly (>= 4.4.1)
  • ipywidgets (>= 7.5.1)

To run the examples, jupyter is required.

User installation

The simplest way to install giotto-tda is using pip

pip install -U giotto-tda

If necessary, this will also automatically install all the above dependencies. Note: we recommend upgrading pip to a recent version as the above may fail on very old versions.

Pre-release, experimental builds containing recently added features, and/or bug fixes can be installed by running

pip install -U giotto-tda-nightly

The main difference between giotto-tda-nightly and the developer installation (see the section on contributing, below) is that the former is shipped with pre-compiled wheels (similarly to the stable release) and hence does not require any C++ dependencies. As the main library module is called gtda in both the stable and nightly versions, giotto-tda and giotto-tda-nightly should not be installed in the same environment.

Contributing

We welcome new contributors of all experience levels. The Giotto community goals are to be helpful, welcoming, and effective. To learn more about making a contribution to giotto-tda, please see the CONTRIBUTING.rst file.

Developer installation

Installing both the PyPI release and source of giotto-tda in the same environment is not recommended since it is known to cause conflicts with the C++ bindings.

The developer installation requires three important C++ dependencies:

  • A C++14 compatible compiler
  • CMake >= 3.9
  • Boost >= 1.56

Please refer to your system's instructions and to the CMake and Boost websites for definitive guidance on how to install these dependencies. The instructions below are unofficial, please follow them at your own risk.

Linux

Most Linux systems should come with a suitable compiler pre-installed. For the other two dependencies, you may consider using your distribution's package manager, e.g. by running

sudo apt-get install cmake libboost-dev

if apt-get is available in your system.

macOS

On macOS, you may consider using brew (https://brew.sh/) to install the dependencies as follows:

brew install gcc cmake boost
Windows

On Windows, you will likely need to have Visual Studio installed. At present, it appears to be important to have a recent version of the VS C++ compiler. One way to check whether this is the case is as follows: 1) open the VS Installer GUI; 2) under the "Installed" tab, click on "Modify" in the relevant VS version; 3) in the newly opened window, select "Individual components" and ensure that v14.24 or above of the MSVC "C++ x64/x86 build tools" is selected. The CMake and Boost dependencies are best installed using the latest binary executables from the websites of the respective projects.

Source code

You can obtain the latest state of the source code with the command:

git clone https://github.com/giotto-ai/giotto-tda.git
To install:
cd giotto-tda
python -m pip install -e ".[dev]"

This way, you can pull the library's latest changes and make them immediately available on your machine. Note: we recommend upgrading pip and setuptools to recent versions before installing in this way.

Testing

After installation, you can launch the test suite from outside the source directory:

pytest gtda

Changelog

See the RELEASE.rst file for a history of notable changes to giotto-tda.

Important links

Community

giotto-ai Slack workspace: https://slack.giotto.ai/

Contacts

maintainers@giotto.ai

You can’t perform that action at this time.