From a637be9cc3ca729069c6c00eb4493d98eedb4617 Mon Sep 17 00:00:00 2001 From: lhenry15 Date: Thu, 10 Sep 2020 01:19:20 -0500 Subject: [PATCH] add docstring generation files Former-commit-id: 5c1a0b6f6ff5550dae44208428cf10beb1f7f0fd [formerly 936669740682110093deb4dc23fd1e61cbc33b9f] [formerly 7407f05aa11027ea9e2e6b0cf31e025ccceb1897 [formerly c49fc592a09f9a1504df7ecda61034eab995cd20]] [formerly da8e4e0187dcb06aece6aa59e62562bac7cd5ce3 [formerly 0055c14619e588e5eb552d35ab29d51b6e872d4d] [formerly 6c472ce3b5d81db34fa728fa5a1a0ec57844de74 [formerly cdbd66261169d52764c26bc3e9ac95258a6727e3]]] [formerly af7c018192ad496aa2f9483d1638c4a9c69b6da8 [formerly d8bdb2bf918fbc53e71beb3647915831fbb4fab9] [formerly a3ba405919f68546a1d914c962b55ea9956ee68a [formerly 7289b9d1435028e01fd7056a7a72c8451a779646]] [formerly a040094ce5b5ed2172a6e71231c05fc1c8e7a2e6 [formerly 12c52218b9139d975b5424b9e39c8e16231416b4] [formerly cb72434bd9e82cbc1c78a6d377b6abda688df95e [formerly bcd899bac05f85105560e2528d913a78fdf07ebd]]]] [formerly a6b104c8a3dd47d6f73c985ceff97e668b15f51d [formerly 5f2137f5e2c3180719dc90019c3453b610d23aae] [formerly a2eef89339e2d73c30bb7322a92cc5b2ea1b3edd [formerly 271d03c8ed410e67ebf684289f5a08e4d8eaabba]] [formerly b62beea5892b59607ea60acb8b300711a66e479d [formerly dae6c5d7aae40e7d1505c0be66dd6a7ce6e8bca3] [formerly 6d8dc1f8a9022d0dafa0a120a5a2f8c624e56cbe [formerly 061b6503ee289addacaea754b1a1f941d66ca3f1]]] [formerly 9079b54651bf93a85ee334698782695620abb5a9 [formerly 46c03c9d30e87036dbf8f7a95418b9891b6960bc] [formerly 41ff6b5bd34cfd9dafdee404364c2648a3814d21 [formerly 5de96244c970801b9d079bd8de19e765583076ed]] [formerly 1ab4f0e73e5d8451de3c9404f90e72687a34f9ea [formerly d720d2c912bd7eedc258d6f5134e5abf9b6e2399] [formerly 84b35c0015770f4ef2743ff0fdf334c88c308b41 [formerly 94b6d6cce9b90dab15c02cde8418fc60487cbb2e]]]]] [formerly d3c147373cb1fa53337f7e7188186308bc0ad458 [formerly 755c49b1f96c2ea1c2c6e206ab9374aeae9ae965] [formerly fbd033cb46bf3eb20e5199aa4b167140d2febdf6 [formerly abb2c168b701cce9248b60e8a8561d5b19f6a290]] [formerly 1a8ec2d7aeb577ddec4b36cafe4f08649d112bd4 [formerly b2eb77b6075b70d67d223d382a14e2eb1c74b0f7] [formerly ff47f7c5c4c9d7eb14a734cbbc85d3c3848e7180 [formerly 737d2b188b8c011e756c808a109c547051a55b4b]]] [formerly 19a30e37da3a6c863cde753d0333c2a23cadd065 [formerly bcdf865d83441b25e14f67fb395d360ae0bd88b8] [formerly a71fdcd46e3cdb02ea44291612fa7d4653a50237 [formerly 6dc1199cd4dd13d3c182adc09616fadb6c820a60]] [formerly 7e502bda87babe46d085c73e9de290177cf3f305 [formerly b3ac13c4aab1da7862c4b47cf4e5402d884301f8] [formerly e7228c77b25d5124215f5e62cb7e322a2e5c5c0b [formerly 719d47de0ef48187b05a82a9dec0d064609e119c]]]] [formerly 1b30373250cad1e69c605152a084fd40458be51e [formerly 7dc0f80752726189908b5d1f8a97b9ec8a8dd7a0] [formerly 24551ef9c8993157ffdb984786d64080c698d6e7 [formerly 18647b51a37767af029b075641fb8d8c7c6a49a2]] [formerly 0977b9cf868f65073feaffa8b3db887814dd70af [formerly bc85edcfec243168cb03e3fc698fd8ffe07659ad] [formerly 52095bd93073caddde6340b453811871cf099e7a [formerly c416e539ca56e77e6ef31b1bc6e3179635794885]]] [formerly 4fa6a9da7f202094bd59fc5b391b66a58852ae9e [formerly 1f824c6a7d8ea45cd163115683923cb7835289c5] [formerly 821ae02ded566d7fa67ea9002f8821648372a621 [formerly 6761ecbc8ee7aae5114e9c327c5d331bb8bf891c]] [formerly facfb4e5187f505dff2a2adca0f4a76a1681eab1 [formerly cfce8c2b9df67b525fda5c793258a412c2182e41] [formerly 144a0371b2f19feb7908ee0ae12e53a168c7b85a [formerly d05389487b7095fffd76f8706d1ae1b0af6356f6]]]]]] Former-commit-id: 59124a1a6e8d1829d41caea4322f885904452853 [formerly e2642a124969ac3e86a74d2341e330f5b2ddb56e] [formerly 80446ce7e0b270ee5d8f576c1e882c5d23782448 [formerly 4976f6d7b27f1b95d123a225f1b077bc97486ca8]] [formerly 9406359ed7950f83a472630754dc864e530e35f4 [formerly 7956bfa32b12e37fa61608510325d01e57788bc6] [formerly e1605f5e67d438e7056c7e6a13d9b31ed80ced39 [formerly b54a0ee35e8da2f24fa91bc817f985e9776f23cb]]] [formerly 672bd26e03ed69f89f467ead23fa4312d11d743b [formerly 8c50c63a834dce3c6c72a83b560d07d3e23b8b9b] [formerly 5e3537aabfe55987bbe0f173b4d034ace22a531f [formerly 9d33331e6658b95d8f5e57cf17ab5af28f61e3fd]] [formerly c90bd0e43f78a9e5481b4563ff6fbc6ebf3d1ed6 [formerly 1012e32c2a19c9e43dfe95614a0837c5bc37223b] [formerly cf1e1df00e91bc63740c7dc3ff9a1787fe6133fb [formerly e43a1a7764305046f2ff87361dd7c510bef98546]]]] [formerly 20a9c4477c747e63724ae87ce690e90b420c8cbc [formerly b213af73a0cbdcabb1417d310c17bb6a5940b46b] [formerly 00a2ba4ccda7eb4a7d224c676ea5652276d18a2a [formerly ccc94342de75e20ea89101004fe0fb11c5520af5]] [formerly 2fb32dc5422ba5b998de3fdaa1a6b8ef5bbc0f56 [formerly 8876777a82886000f1f4f59193b742faa9a1d6db] [formerly b0e02e0b73614b6098473e1815f2de924fd41a65 [formerly 1e465b26e22d8968018e3a47d10f92c13dc16407]]] [formerly 82a6d4d8f6d764e7214eec2258fb81797bc484f1 [formerly 19a1ac78d169c0ab66be3446936df881c5030f1a] [formerly 8851f61bf048c0c1cd48a4080ee6c310976b97c7 [formerly d5f5d8db9e58095ed3f7fd3da5aac13a492951d7]] [formerly 3728a28ec43225b0e2144c2caa75e292ebd1f780 [formerly 4ee7156c68c5937a2feeb5e09241d79526309c2c] [formerly 144a0371b2f19feb7908ee0ae12e53a168c7b85a]]]] Former-commit-id: c2309eba7adb533810394ab56fef3895cc502138 [formerly 72a10ffd806caddd3ecea23a1099f13e63bef571] [formerly 9a7046c6875aea32bd550cfcd45177d29fecaab8 [formerly 4b62de90caac5e3a33d896a31ee449900d2e0cc9]] [formerly fa29618fc3a39f99c4c7ca97cdcd9e5520a20ff7 [formerly d5f462e472835a9b85ab3e2add49bbb560078a6c] [formerly 27dde60d111b9ff305a3eff5cc501d6303213dbc [formerly 3b3cff6dcea8563fff5ef03f70faa0e96bb2adfe]]] [formerly 70a3052e2ee3ee5f530ef98921bfcefc0ebbc09b [formerly b5f717b44788a3721cc6cb0197bf621a2e3cd087] [formerly 2620325460aa95216f7c8e4c3e3c2f4e797dcbf8 [formerly ba6e8e01f0c3cd2398c48b755a1bac9642080676]] [formerly c145b572f4744d5a5c184fafed5cf48d9dcae4e2 [formerly 78a87710fe1ae92b40c0406e8ad96720907912ab] [formerly 1d3d24f24d01e5f35107d98be22f061256855da4 [formerly 0be035483764d95e6858341879427d3cbab940d1]]]] Former-commit-id: 5cd15e27b3eb8d5e3b86df6b2c37e17d1ddeae85 [formerly 57d47f99a27bc0677994fe7aeb2ea1ea1f1e09f5] [formerly 445cdf6fb04dc42cb19a15376b1d64ab3950cdb0 [formerly ab1f6d2cfd64740cf4a1d5eea3dbbfa9c8168867]] [formerly bde7dc67619f5d5c9c5b5e4b0f27c85fb8c7b88b [formerly 2ecdd6189a6e869606cc027a045a1caa33362d72] [formerly 04b1d3d70cac6ece39dda8d97714477725abef1e [formerly cd96e107d725d58a90c1dc777a0fe859da93156a]]] Former-commit-id: 79c77da43ea178ce7999fbb78da0d6319c67ecae [formerly ccaefbc79b6487676297732eafeeb1758d79c007] [formerly 22742f05412585d1664ac19ce23382b70c8c24db [formerly 4cd25bc4b705629ab2bef7fdd00f0b7d53f04c62]] Former-commit-id: e860c86fcb2db3da12157b810263407e7f5a6394 [formerly 2045eb9a95b1b553b863edc8124a77286de14b6e] Former-commit-id: 293cd138d439f0ab104991e08b791ce1639447ff --- docs/Makefile | 20 +++ docs/make.bat | 35 ++++ docs/source/conf.py | 76 +++++++++ docs/source/index.rst | 20 +++ docs/source/modules.rst | 7 + docs/source/tods.data_processing.rst | 69 ++++++++ docs/source/tods.detection_algorithm.rst | 189 +++++++++++++++++++++ docs/source/tods.feature_analysis.rst | 253 +++++++++++++++++++++++++++++ docs/source/tods.reinforcement.rst | 21 +++ docs/source/tods.rst | 24 +++ docs/source/tods.searcher.rst | 37 +++++ docs/source/tods.searcher.search.rst | 21 +++ docs/source/tods.timeseries_processing.rst | 85 ++++++++++ 13 files changed, 857 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/tods.data_processing.rst create mode 100644 docs/source/tods.detection_algorithm.rst create mode 100644 docs/source/tods.feature_analysis.rst create mode 100644 docs/source/tods.reinforcement.rst create mode 100644 docs/source/tods.rst create mode 100644 docs/source/tods.searcher.rst create mode 100644 docs/source/tods.searcher.search.rst create mode 100644 docs/source/tods.timeseries_processing.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# 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/make.bat b/docs/make.bat new file mode 100644 index 0000000..6247f7e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..1acf538 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,76 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.append(os.path.abspath('../../tods')) +sys.path.append(os.path.abspath('../../')) + +# -- Auto-doc Skip -------------------- +def skip_member(app, what, name, obj, skip, opts): + # we can document otherwise excluded entities here by returning False + # or skip otherwise included entities by returning True + if name == "__author" or name == "metadata": + return True + return None + +def setup(app): + app.connect('autodoc-skip-member', skip_member) + +# -- Project information ----------------------------------------------------- + +project = 'Time Series Outlier Detection System' +copyright = '2020, DataLab@Texas A&M University' +author = 'DataLab@Texas A&M University' + +# The full version, including alpha/beta/rc tags +release = '0.0.1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.githubpages', + 'sphinx.ext.napoleon', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] +source_suffix = '.rst' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..0a7b6e9 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. Time Series Outlier Detection System documentation master file, created by + sphinx-quickstart on Wed Sep 9 22:52:15 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Time Series Outlier Detection System's documentation! +================================================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..0380d02 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +tods +==== + +.. toctree:: + :maxdepth: 3 + + tods diff --git a/docs/source/tods.data_processing.rst b/docs/source/tods.data_processing.rst new file mode 100644 index 0000000..f710b40 --- /dev/null +++ b/docs/source/tods.data_processing.rst @@ -0,0 +1,69 @@ +tods.data\_processing package +============================= + +Submodules +---------- + +tods.data\_processing.CategoricalToBinary module +------------------------------------------------ + +.. automodule:: tods.data_processing.CategoricalToBinary + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.ColumnFilter module +----------------------------------------- + +.. automodule:: tods.data_processing.ColumnFilter + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.ContinuityValidation module +------------------------------------------------- + +.. automodule:: tods.data_processing.ContinuityValidation + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.DatasetToDataframe module +----------------------------------------------- + +.. automodule:: tods.data_processing.DatasetToDataframe + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.DuplicationValidation module +-------------------------------------------------- + +.. automodule:: tods.data_processing.DuplicationValidation + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.TimeIntervalTransform module +-------------------------------------------------- + +.. automodule:: tods.data_processing.TimeIntervalTransform + :members: + :noindex: + :show-inheritance: + +tods.data\_processing.TimeStampValidation module +------------------------------------------------ + +.. automodule:: tods.data_processing.TimeStampValidation + :members: + :noindex: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.data_processing + :members: + :noindex: + :show-inheritance: diff --git a/docs/source/tods.detection_algorithm.rst b/docs/source/tods.detection_algorithm.rst new file mode 100644 index 0000000..5329ab7 --- /dev/null +++ b/docs/source/tods.detection_algorithm.rst @@ -0,0 +1,189 @@ +tods.detection\_algorithm package +================================= + +Submodules +---------- + +tods.detection\_algorithm.AutoRegODetect module +----------------------------------------------- + +.. automodule:: tods.detection_algorithm.AutoRegODetect + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.DeepLog module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.DeepLog + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.KDiscordODetect module +------------------------------------------------ + +.. automodule:: tods.detection_algorithm.KDiscordODetect + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.LSTMODetect module +-------------------------------------------- + +.. automodule:: tods.detection_algorithm.LSTMODetect + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.MatrixProfile module +---------------------------------------------- + +.. automodule:: tods.detection_algorithm.MatrixProfile + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PCAODetect module +------------------------------------------- + +.. automodule:: tods.detection_algorithm.PCAODetect + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodABOD module +----------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodABOD + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodAE module +--------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodAE + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodCBLOF module +------------------------------------------ + +.. automodule:: tods.detection_algorithm.PyodCBLOF + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodCOF module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodCOF + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodHBOS module +----------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodHBOS + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodIsolationForest module +---------------------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodIsolationForest + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodKNN module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodKNN + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodLODA module +----------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodLODA + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodLOF module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodLOF + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodMoGaal module +------------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodMoGaal + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodOCSVM module +------------------------------------------ + +.. automodule:: tods.detection_algorithm.PyodOCSVM + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodSOD module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodSOD + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodSoGaal module +------------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodSoGaal + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.PyodVAE module +---------------------------------------- + +.. automodule:: tods.detection_algorithm.PyodVAE + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.Telemanom module +------------------------------------------ + +.. automodule:: tods.detection_algorithm.Telemanom + :members: + :noindex: + :show-inheritance: + +tods.detection\_algorithm.UODBasePrimitive module +------------------------------------------------- + +.. automodule:: tods.detection_algorithm.UODBasePrimitive + :members: + :noindex: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.detection_algorithm + :members: + :noindex: + :show-inheritance: diff --git a/docs/source/tods.feature_analysis.rst b/docs/source/tods.feature_analysis.rst new file mode 100644 index 0000000..257468c --- /dev/null +++ b/docs/source/tods.feature_analysis.rst @@ -0,0 +1,253 @@ +tods.feature\_analysis package +============================== + +Submodules +---------- + +tods.feature\_analysis.AutoCorrelation module +--------------------------------------------- + +.. automodule:: tods.feature_analysis.AutoCorrelation + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.BKFilter module +-------------------------------------- + +.. automodule:: tods.feature_analysis.BKFilter + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.DiscreteCosineTransform module +----------------------------------------------------- + +.. automodule:: tods.feature_analysis.DiscreteCosineTransform + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.FastFourierTransform module +-------------------------------------------------- + +.. automodule:: tods.feature_analysis.FastFourierTransform + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.HPFilter module +-------------------------------------- + +.. automodule:: tods.feature_analysis.HPFilter + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.NonNegativeMatrixFactorization module +------------------------------------------------------------ + +.. automodule:: tods.feature_analysis.NonNegativeMatrixFactorization + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.SKTruncatedSVD module +-------------------------------------------- + +.. automodule:: tods.feature_analysis.SKTruncatedSVD + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.SpectralResidualTransform module +------------------------------------------------------- + +.. automodule:: tods.feature_analysis.SpectralResidualTransform + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalAbsEnergy module +-------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalAbsEnergy + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalAbsSum module +----------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalAbsSum + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalGmean module +---------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalGmean + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalHmean module +---------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalHmean + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalKurtosis module +------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalKurtosis + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMaximum module +------------------------------------------------ + +.. automodule:: tods.feature_analysis.StatisticalMaximum + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMean module +--------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalMean + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMeanAbs module +------------------------------------------------ + +.. automodule:: tods.feature_analysis.StatisticalMeanAbs + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMeanAbsTemporalDerivative module +------------------------------------------------------------------ + +.. automodule:: tods.feature_analysis.StatisticalMeanAbsTemporalDerivative + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMeanTemporalDerivative module +--------------------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalMeanTemporalDerivative + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMedian module +----------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalMedian + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMedianAbsoluteDeviation module +---------------------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalMedianAbsoluteDeviation + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalMinimum module +------------------------------------------------ + +.. automodule:: tods.feature_analysis.StatisticalMinimum + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalSkew module +--------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalSkew + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalStd module +-------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalStd + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalVar module +-------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalVar + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalVariation module +-------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalVariation + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalVecSum module +----------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalVecSum + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalWillisonAmplitude module +---------------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalWillisonAmplitude + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.StatisticalZeroCrossing module +----------------------------------------------------- + +.. automodule:: tods.feature_analysis.StatisticalZeroCrossing + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.TRMF module +---------------------------------- + +.. automodule:: tods.feature_analysis.TRMF + :members: + :noindex: + :show-inheritance: + +tods.feature\_analysis.WaveletTransform module +---------------------------------------------- + +.. automodule:: tods.feature_analysis.WaveletTransform + :members: + :noindex: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.feature_analysis + :members: + :noindex: + :show-inheritance: diff --git a/docs/source/tods.reinforcement.rst b/docs/source/tods.reinforcement.rst new file mode 100644 index 0000000..7f9d53a --- /dev/null +++ b/docs/source/tods.reinforcement.rst @@ -0,0 +1,21 @@ +tods.reinforcement package +========================== + +Submodules +---------- + +tods.reinforcement.RuleBasedFilter module +----------------------------------------- + +.. automodule:: tods.reinforcement.RuleBasedFilter + :members: + :noindex: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.reinforcement + :members: + :noindex: + :show-inheritance: diff --git a/docs/source/tods.rst b/docs/source/tods.rst new file mode 100644 index 0000000..fe07262 --- /dev/null +++ b/docs/source/tods.rst @@ -0,0 +1,24 @@ +tods package +============ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + tods.data_processing + tods.detection_algorithm + tods.feature_analysis + tods.reinforcement + tods.searcher + tods.timeseries_processing + + +Module contents +--------------- + +.. automodule:: tods + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/tods.searcher.rst b/docs/source/tods.searcher.rst new file mode 100644 index 0000000..68e9305 --- /dev/null +++ b/docs/source/tods.searcher.rst @@ -0,0 +1,37 @@ +tods.searcher package +===================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + tods.searcher.search + +Submodules +---------- + +tods.searcher.schemas module +---------------------------- + +.. automodule:: tods.searcher.schemas + :members: + :undoc-members: + :show-inheritance: + +tods.searcher.utils module +-------------------------- + +.. automodule:: tods.searcher.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.searcher + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/tods.searcher.search.rst b/docs/source/tods.searcher.search.rst new file mode 100644 index 0000000..9c6232a --- /dev/null +++ b/docs/source/tods.searcher.search.rst @@ -0,0 +1,21 @@ +tods.searcher.search package +============================ + +Submodules +---------- + +tods.searcher.search.brute\_force\_search module +------------------------------------------------ + +.. automodule:: tods.searcher.search.brute_force_search + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.searcher.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/tods.timeseries_processing.rst b/docs/source/tods.timeseries_processing.rst new file mode 100644 index 0000000..e14fc6a --- /dev/null +++ b/docs/source/tods.timeseries_processing.rst @@ -0,0 +1,85 @@ +tods.timeseries\_processing package +=================================== + +Submodules +---------- + +tods.timeseries\_processing.HoltSmoothing module +------------------------------------------------ + +.. automodule:: tods.timeseries_processing.HoltSmoothing + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.HoltWintersExponentialSmoothing module +------------------------------------------------------------------ + +.. automodule:: tods.timeseries_processing.HoltWintersExponentialSmoothing + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.MovingAverageTransform module +--------------------------------------------------------- + +.. automodule:: tods.timeseries_processing.MovingAverageTransform + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.SKAxiswiseScaler module +--------------------------------------------------- + +.. automodule:: tods.timeseries_processing.SKAxiswiseScaler + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.SKPowerTransformer module +----------------------------------------------------- + +.. automodule:: tods.timeseries_processing.SKPowerTransformer + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.SKQuantileTransformer module +-------------------------------------------------------- + +.. automodule:: tods.timeseries_processing.SKQuantileTransformer + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.SKStandardScaler module +--------------------------------------------------- + +.. automodule:: tods.timeseries_processing.SKStandardScaler + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.SimpleExponentialSmoothing module +------------------------------------------------------------- + +.. automodule:: tods.timeseries_processing.SimpleExponentialSmoothing + :members: + :noindex: + :show-inheritance: + +tods.timeseries\_processing.TimeSeriesSeasonalityTrendDecomposition module +-------------------------------------------------------------------------- + +.. automodule:: tods.timeseries_processing.TimeSeriesSeasonalityTrendDecomposition + :members: + :noindex: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tods.timeseries_processing + :members: + :noindex: + :show-inheritance: