.. _api_ref:

API 参考
=============

.. currentmodule:: featuretools

演示数据集
~~~~~~~~~~~~~
.. currentmodule:: featuretools.demo


.. autosummary::
    :toctree: generated/

    load_retail
    load_mock_customer
    load_flight
    load_weather

深度特征合成
~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools

.. autosummary::
    :toctree: generated/

    dfs
    get_valid_primitives

时间增量
~~~~~~~~~
.. currentmodule:: featuretools

.. autosummary::
    :toctree: generated/

    Timedelta

时间工具
~~~~~~~~~~
.. currentmodule:: featuretools

.. autosummary::
    :toctree: generated/

    make_temporal_cutoffs


特征基元
~~~~~~~~~~~~~~~~~~

基元类型
---------------
.. currentmodule:: featuretools.primitives

.. autosummary::
    :toctree: generated/

    TransformPrimitive
    AggregationPrimitive


.. _api_ref.aggregation_features:

聚合基元
----------------------
.. autosummary::
    :toctree: generated/

    All
    Any
    AvgTimeBetween
    Count
    CountAboveMean
    CountBelowMean
    CountGreaterThan
    CountInsideNthSTD
    CountInsideRange
    CountLessThan
    CountOutsideNthSTD
    CountOutsideRange
    Entropy
    First
    Last
    Max
    MaxConsecutiveFalse
    MaxConsecutiveNegatives
    MaxConsecutivePositives
    MaxConsecutiveTrue
    MaxConsecutiveZeros
    Mean
    Median
    Min
    Mode
    NMostCommon
    NumConsecutiveGreaterMean
    NumConsecutiveLessMean
    NumTrue
    NumUnique
    PercentTrue
    Skew
    Std
    Sum
    TimeSinceFirst
    TimeSinceLast
    TimeSinceLastFalse
    TimeSinceLastMax
    TimeSinceLastMin
    TimeSinceLastTrue
    Trend

转换基元
--------------------
二元转换基元
***************************
.. autosummary::
    :toctree: generated/

    AddNumeric
    AddNumericScalar
    DivideByFeature
    DivideNumericScalar
    Equal
    EqualScalar
    GreaterThan
    GreaterThanEqualTo
    GreaterThanEqualToScalar
    GreaterThanScalar
    LessThan
    LessThanEqualTo
    LessThanEqualToScalar
    LessThanScalar
    ModuloByFeature
    ModuloNumeric
    ModuloNumericScalar
    MultiplyBoolean
    MultiplyNumericBoolean
    MultiplyNumericScalar
    NotEqual
    NotEqualScalar
    ScalarSubtractNumericFeature
    SubtractNumeric
    SubtractNumericScalar


组合特征
********
.. autosummary::
    :toctree: generated/

    IsIn
    And
    Or
    Not


.. _api_ref.cumulative_features:

累积变换原语
************
.. autosummary::
    :toctree: generated/

    Diff
    DiffDatetime
    TimeSincePrevious
    CumCount
    CumSum
    CumMean
    CumMin
    CumMax


日期时间变换原语
****************
.. autosummary::
    :toctree: generated/

    Age
    DateToHoliday
    DateToTimeZone
    Day
    DayOfYear
    DaysInMonth
    DistanceToHoliday
    Hour
    IsFederalHoliday
    IsLeapYear
    IsLunchTime
    IsMonthEnd
    IsMonthStart
    IsQuarterEnd
    IsQuarterStart
    IsWeekend
    IsWorkingHours
    IsYearEnd
    IsYearStart
    Minute
    Month
    PartOfDay
    Quarter
    Season
    Second
    Week
    Weekday
    Year


电子邮件和URL变换原语
********************
.. autosummary::
    :toctree: generated/

    EmailAddressToDomain
    IsFreeEmailDomain
    URLToDomain
    URLToProtocol
    URLToTLD


指数变换原语
************
.. autosummary::
    :toctree: generated/

    ExponentialWeightedAverage
    ExponentialWeightedSTD
    ExponentialWeightedVariance


通用变换原语
************
.. autosummary::
    :toctree: generated/

    AbsoluteDiff
    Absolute
    Cosine
    IsNull
    NaturalLogarithm
    Negate
    Percentile
    RateOfChange
    SameAsPrevious
    Sine
    SquareRoot
    Tangent
    Variance

位置变换原语
************
.. autosummary::
    :toctree: generated/
   :toctree: generated/

    CityblockDistance
    GeoMidpoint
    Haversine
    IsInGeoBox
    Latitude
    Longitude

自然语言转换原语
************************************
.. autosummary::
   :toctree: generated/

   CountString
   MeanCharactersPerWord
   MedianWordLength
   NumCharacters
   NumUniqueSeparators
   NumWords
   NumberOfCommonWords
   NumberOfHashtags
   NumberOfMentions
   NumberOfUniqueWords
   NumberOfWordsInQuotes
   PunctuationCount
   TitleWordCount
   TotalWordLength
   UpperCaseCount
   UpperCaseWordCount
   WhitespaceCount

邮政编码原语
**********************
.. autosummary::
    :toctree: generated/

    OneDigitPostalCode
    TwoDigitPostalCode

时间序列转换原语
********************************
.. autosummary::
    :toctree: generated/

    ExpandingCount
    ExpandingMax
    ExpandingMean
    ExpandingMin
    ExpandingSTD
    ExpandingTrend
    Lag
    RollingCount
    RollingMax
    RollingMean
    RollingMin
    RollingOutlierCount
    RollingSTD
    RollingTrend


特征方法
---------------
.. currentmodule:: featuretools.feature_base
.. autosummary::
    :toctree: generated/

    FeatureBase.rename
    FeatureBase.get_depth


特征计算
~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    calculate_feature_matrix
    .. approximate_features

特征描述
~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    describe_feature

特征可视化
~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    graph_feature

特征编码
~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    encode_features

特征选择
~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools.selection
.. autosummary::
    :toctree: generated/

    remove_low_information_features
移除高度相关特征
移除高度缺失特征
移除单一值特征

特征矩阵工具
~~~~~~~~~~~~
.. currentmodule:: featuretools.computational_backends
.. autosummary::
    :toctree: generated/

    replace_inf_values


保存和加载特征
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    save_features
    load_features

.. _api_ref.dataset:

EntitySet, 关系
~~~~~~~~~~~~~~~~~~~~~~~

构造函数
------------
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    EntitySet
    Relationship

EntitySet 加载和准备数据
-------------------------------
.. autosummary::
    :toctree: generated/

    EntitySet.add_dataframe
    EntitySet.add_interesting_values
    EntitySet.add_last_time_indexes
    EntitySet.add_relationship
    EntitySet.add_relationships
    EntitySet.concat
    EntitySet.normalize_dataframe
    EntitySet.set_secondary_time_index
    EntitySet.replace_dataframe

EntitySet 序列化
-------------------------------
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    read_entityset

.. currentmodule:: featuretools.entityset
.. autosummary::
    :toctree: generated/

    EntitySet.to_csv
    EntitySet.to_pickle
    EntitySet.to_parquet

EntitySet 查询方法
-----------------------
.. autosummary::
    :toctree: generated/

    EntitySet.__getitem__
    EntitySet.find_backward_paths
    EntitySet.find_forward_paths
    EntitySet.get_forward_dataframes
    EntitySet.get_backward_dataframes
    EntitySet.query_by_values

EntitySet 可视化
-----------------------
.. autosummary::
    :toctree: generated/

    EntitySet.plot

关系属性
-----------------------
.. autosummary::
    :toctree: generated/

    Relationship.parent_column
    Relationship.child_column
    Relationship.parent_dataframe
    Relationship.child_dataframe

数据类型工具方法
----------------------
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    list_logical_types
    list_semantic_tags

原语工具方法
----------------------
.. currentmodule:: featuretools
.. autosummary::
    :toctree: generated/

    get_recommended_primitives
    list_primitives
    summarize_primitives