.. _api: ================= API Documentation ================= Full API documentation of the *pyts* Python package. :mod:`pyts.approximation`: Approximation algorithms =================================================== .. automodule:: pyts.approximation :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst approximation.DiscreteFourierTransform approximation.MultipleCoefficientBinning approximation.PiecewiseAggregateApproximation approximation.SymbolicAggregateApproximation approximation.SymbolicFourierApproximation :mod:`pyts.bag_of_words`: Bag-of-words algorithms ================================================= .. automodule:: pyts.bag_of_words :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst bag_of_words.BagOfWords bag_of_words.WordExtractor :mod:`pyts.classification`: Classification algorithms ===================================================== .. automodule:: pyts.classification :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst classification.BOSSVS classification.KNeighborsClassifier classification.LearningShapelets classification.SAXVSM classification.TimeSeriesForest classification.TSBF :mod:`pyts.datasets`: Dataset loading utilities =============================================== .. automodule:: pyts.datasets :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: function.rst datasets.fetch_ucr_dataset datasets.fetch_uea_dataset datasets.load_basic_motions datasets.load_coffee datasets.load_gunpoint datasets.load_pig_central_venous_pressure datasets.make_cylinder_bell_funnel datasets.ucr_dataset_info datasets.ucr_dataset_list datasets.uea_dataset_info datasets.uea_dataset_list :mod:`pyts.decomposition`: Decomposition algorithms =================================================== .. automodule:: pyts.decomposition :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst decomposition.SingularSpectrumAnalysis :mod:`pyts.image`: Imaging algorithms ===================================== .. automodule:: pyts.image :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst image.GramianAngularField image.MarkovTransitionField image.RecurrencePlot :mod:`pyts.metrics`: Metrics ============================ .. automodule:: pyts.metrics :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: function.rst metrics.boss metrics.dtw metrics.itakura_parallelogram metrics.sakoe_chiba_band metrics.show_options :mod:`pyts.multivariate`: Multivariate time series tools ======================================================== .. automodule:: pyts.multivariate :no-members: :no-inherited-members: .. currentmodule:: pyts Classification -------------- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst multivariate.classification.MultivariateClassifier Image ----- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst multivariate.image.JointRecurrencePlot Transformation -------------- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst multivariate.transformation.MultivariateTransformer multivariate.transformation.WEASELMUSE Utils ----- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: function.rst multivariate.utils.check_3d_array :mod:`pyts.preprocessing`: Preprocessing tools ============================================== .. automodule:: pyts.preprocessing :no-members: :no-inherited-members: .. currentmodule:: pyts Scaling ------- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst preprocessing.MaxAbsScaler preprocessing.MinMaxScaler preprocessing.RobustScaler preprocessing.StandardScaler Transformation -------------- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst preprocessing.PowerTransformer preprocessing.QuantileTransformer Discretizing ------------ .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst preprocessing.KBinsDiscretizer Imputation ---------- .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst preprocessing.InterpolationImputer :mod:`pyts.transformation`: Transformation algorithms ===================================================== .. automodule:: pyts.transformation :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: class.rst transformation.BagOfPatterns transformation.BOSS transformation.ROCKET transformation.ShapeletTransform transformation.WEASEL :mod:`pyts.utils`: Utility tools ================================ .. automodule:: pyts.utils :no-members: :no-inherited-members: .. currentmodule:: pyts .. autosummary:: :toctree: generated/ :template: function.rst utils.segmentation utils.windowed_view