-
-

Welcome to pyFTS’s documentation!¶

+
+

pyFTS - Fuzzy Time Series for Python¶

What is pyFTS Library?¶

https://badges.frapsoft.com/os/v2/open-source.png?v=103 -https://img.shields.io/badge/License-GPLv3-blue.svghttps://img.shields.io/badge/Made%20with-Python-1f425f.svg

This package is intended for students, researchers, data scientists or whose want to exploit the Fuzzy Time Series methods. These methods provide simple, easy to use, computationally cheap and human-readable models, suitable from statistic laymans to experts.

+https://img.shields.io/badge/License-GPLv3-blue.svghttps://img.shields.io/badge/Made%20with-Python-1f425f.svg + Fork me on GitHub

This package is intended for students, researchers, data scientists or whose want to exploit the Fuzzy Time Series methods. These methods provide simple, easy to use, computationally cheap and human-readable models, suitable from statistic laymans to experts.

This tool is developed on MINDS Lab, headed by Prof. Frederico Gadelha Guimarães from Electrical Engineering Departament of Federal University @@ -133,8 +141,8 @@ src="http://www.ifmg.edu.br/portal/imagens/logovertical.jpg" alt="IFMG" width="1

How to reference pyFTS?¶

-https://zenodo.org/badge/DOI/10.5281/zenodo.1405817.svg -

Silva, P. C. L. et al. pyFTS: Fuzzy Time Series for Python (Version v4.0). Belo Horizonte. 2018. DOI: 10.5281/zenodo.1405817. Url: <https://doi.org/10.5281/zenodo.1405817>

+https://zenodo.org/badge/DOI/10.5281/zenodo.597359.svg +

Silva, P. C. L. et al. pyFTS: Fuzzy Time Series for Python. Belo Horizonte. 2018. DOI: 10.5281/zenodo.597359. Url: <https://doi.org/10.5281/zenodo.597359>

Indexes¶

diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html index b6b41fc..109b34d 100644 --- a/docs/build/html/modules.html +++ b/docs/build/html/modules.html @@ -117,21 +117,28 @@
  • pyFTS.data package
  • pyFTS.models package
      diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index b15edec..0481bb4 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/pyFTS.common.html b/docs/build/html/pyFTS.common.html index ae48148..f5e369b 100644 --- a/docs/build/html/pyFTS.common.html +++ b/docs/build/html/pyFTS.common.html @@ -381,17 +381,40 @@
      -pyFTS.common.FuzzySet.check_bounds(data, sets, ordered_sets)[source]¶
      +pyFTS.common.FuzzySet.check_bounds(data, fuzzy_sets, ordered_sets)[source]¶
      -pyFTS.common.FuzzySet.check_bounds_index(data, sets, ordered_sets)[source]¶
      +pyFTS.common.FuzzySet.check_bounds_index(data, fuzzy_sets, ordered_sets)[source]¶
      +
      +
      +pyFTS.common.FuzzySet.fuzzyfy(data, partitioner, **kwargs)[source]¶
      +

      A general method for fuzzyfication.

      + +++ + + + +
      Parameters:
        +
      • data – input value to be fuzzyfied
        • +
      • partitioner – a trained pyFTS.partitioners.Partitioner object
        • +
      • kwargs – dict, optional arguments
        • +
      • alpha_cut – the minimal membership value to be considered on fuzzyfication (only for mode=’sets’)
        • +
      • method – the fuzzyfication method (fuzzy: all fuzzy memberships, maximum: only the maximum membership)
        • +
      • mode – the fuzzyfication mode (sets: return the fuzzy sets names, vector: return a vector with the membership values for all fuzzy sets)
        • +
      +
      +

      :returns a list with the fuzzyfied values, depending on the mode

      +
      +
      -pyFTS.common.FuzzySet.fuzzyfy_instance(inst, fuzzySets, ordered_sets=None)[source]¶
      +pyFTS.common.FuzzySet.fuzzyfy_instance(inst, fuzzy_sets, ordered_sets=None)[source]¶

      Calculate the membership values for a data point given fuzzy sets

      @@ -399,7 +422,8 @@ @@ -412,7 +436,7 @@
      -pyFTS.common.FuzzySet.fuzzyfy_instances(data, fuzzySets, ordered_sets=None)[source]¶
      +pyFTS.common.FuzzySet.fuzzyfy_instances(data, fuzzy_sets, ordered_sets=None)[source]¶

      Calculate the membership values for a data point given fuzzy sets

      Parameters:
      • inst – data point
        • -
      • fuzzySets – dict of fuzzy sets
        • +
      • fuzzy_sets – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.
        • +
      • ordered_sets – a list with the fuzzy sets names ordered by their centroids.
      @@ -420,7 +444,8 @@ @@ -433,17 +458,17 @@
      -pyFTS.common.FuzzySet.fuzzyfy_series(data, fuzzySets, method='maximum', alpha_cut=0.0)[source]¶
      +pyFTS.common.FuzzySet.fuzzyfy_series(data, fuzzy_sets, method='maximum', alpha_cut=0.0, ordered_sets=None)[source]¶
      -pyFTS.common.FuzzySet.fuzzyfy_series_old(data, fuzzySets, method='maximum')[source]¶
      +pyFTS.common.FuzzySet.fuzzyfy_series_old(data, fuzzy_sets, method='maximum')[source]¶
      -pyFTS.common.FuzzySet.get_fuzzysets(inst, fuzzySets, ordered_sets=None, alpha_cut=0.0)[source]¶
      +pyFTS.common.FuzzySet.get_fuzzysets(inst, fuzzy_sets, ordered_sets=None, alpha_cut=0.0)[source]¶

      Return the fuzzy sets which membership value for a inst is greater than the alpha_cut

      Parameters:
      • inst – data point
        • -
      • fuzzySets – dict of fuzzy sets
        • +
      • fuzzy_sets – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.
        • +
      • ordered_sets – a list with the fuzzy sets names ordered by their centroids.
      @@ -451,7 +476,8 @@ @@ -465,7 +491,7 @@
      -pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset(inst, fuzzySets, ordered_sets=None)[source]¶
      +pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset(inst, fuzzy_sets, ordered_sets=None)[source]¶

      Fuzzify a data point, returning the fuzzy set with maximum membership value

      Parameters:
      • inst – data point
        • -
      • fuzzySets – dict of fuzzy sets
        • +
      • fuzzy_sets – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.
        • +
      • ordered_sets – a list with the fuzzy sets names ordered by their centroids.
      • alpha_cut – Minimal membership to be considered on fuzzyfication process
      @@ -473,7 +499,8 @@ @@ -486,7 +513,7 @@
      -pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index(inst, fuzzySets)[source]¶
      +pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index(inst, fuzzy_sets)[source]¶

      Fuzzify a data point, returning the fuzzy set with maximum membership value

      Parameters:
      • inst – data point
        • -
      • fuzzySets – dict of fuzzy sets
        • +
      • fuzzy_sets – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.
        • +
      • ordered_sets – a list with the fuzzy sets names ordered by their centroids.
      @@ -494,7 +521,7 @@ @@ -507,13 +534,23 @@
      -pyFTS.common.FuzzySet.grant_bounds(data, sets, ordered_sets)[source]¶
      +pyFTS.common.FuzzySet.grant_bounds(data, fuzzy_sets, ordered_sets)[source]¶
      -pyFTS.common.FuzzySet.set_ordered(fuzzySets)[source]¶
      +pyFTS.common.FuzzySet.set_ordered(fuzzy_sets)[source]¶

      Order a fuzzy set list by their centroids

      +
      Parameters:
      • inst – data point
        • -
      • fuzzySets – dict of fuzzy sets
        • +
      • fuzzy_sets – dict of fuzzy sets
      +++ + + + + + +
      Parameters:fuzzy_sets – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.
      Returns:a list with the fuzzy sets names ordered by their centroids.
    • @@ -583,6 +620,25 @@ +
    +
    +pyFTS.common.Membership.singleton(x, parameters)[source]¶
    +

    Singleton membership function, a single value fuzzy function

    + +++ + + + +
    Parameters:
      +
    • x –
      • +
    • parameters – a list with one real value
      • +
    +
    +

    :returns

    +
    +
    pyFTS.common.Membership.trapmf(x, parameters)[source]¶
    diff --git a/docs/build/html/pyFTS.data.html b/docs/build/html/pyFTS.data.html index f302829..d9de2ff 100644 --- a/docs/build/html/pyFTS.data.html +++ b/docs/build/html/pyFTS.data.html @@ -194,7 +194,7 @@ If the file don’t already exists, it will be downloaded and decompressed.

    Source: https://finance.yahoo.com/quote/BTC-USD?p=BTC-USD

    -pyFTS.data.Bitcoin.get_data(field='avg')[source]¶
    +pyFTS.data.Bitcoin.get_data(field='AVG')[source]¶

    Get the univariate time series data.

    @@ -230,7 +230,7 @@ If the file don’t already exists, it will be downloaded and decompressed.

    Source: https://finance.yahoo.com/quote/%5EGSPC/history?p=%5EGSPC

    -pyFTS.data.DowJones.get_data(field='avg')[source]¶
    +pyFTS.data.DowJones.get_data(field='AVG')[source]¶

    Get the univariate time series data.

    @@ -289,7 +289,7 @@ If the file don’t already exists, it will be downloaded and decompressed.

    Source: https://finance.yahoo.com/quote/ETH-USD?p=ETH-USD

    -pyFTS.data.Ethereum.get_data(field='avg')[source]¶
    +pyFTS.data.Ethereum.get_data(field='AVG')[source]¶

    Get the univariate time series data.

    diff --git a/docs/build/html/quickstart.html b/docs/build/html/quickstart.html index 2b730fc..3c7255e 100644 --- a/docs/build/html/quickstart.html +++ b/docs/build/html/quickstart.html @@ -18,7 +18,7 @@ - +