giotto-ai / giotto-tda

A high-performance topological machine learning toolbox in Python
https://giotto-ai.github.io/gtda-docs
Other
858 stars 175 forks source link

[DOCS] Clarify expected diagram properties to fix #233 #443

Closed ulupo closed 4 years ago

ulupo commented 4 years ago

Reference issues/PRs Fixes #233.

Types of changes

Description As observed in #233, there are implicit assumptions on the input diagrams to the fit and transform methods of most transformers in gtda/diagrams. Most stem from the fact that we call the _subdiagrams function which will break unless all sample diagrams in a collection X have the same number of persistence triples in each homology dimension. This PR extends the approach introduced in https://github.com/giotto-ai/giotto-tda/pull/436/commits/9068c9d978d87ad4279a89fc2a9f26bb6ceea1b7 for Filtering to all transformers in gtda/diagrams with the only exception of ForgetDimension (which does not make use of _subdiagrams).

Checklist