Firelink
0.1.1

Contents:

  • Installation
  • Quick Start
  • Developer instructions
  • Firelink
    • firelink package
      • Submodules
      • firelink.fire module
      • firelink.logger module
      • firelink.pipeline module
      • firelink.replace module
      • firelink.spark_transform module
      • firelink.transform module
      • Module contents
    • setup module
Firelink
  • »
  • Firelink »
  • firelink package
  • View page source

firelink package¶

Submodules¶

firelink.fire module¶

class firelink.fire.Firstflame[source]¶

Bases: abc.ABC, sklearn.base.BaseEstimator, sklearn.base.TransformerMixin

Base Firstflame Class

fit(X, y=None)[source]¶

Passing through

abstract transform(X, y=None)[source]¶

abstract

firelink.logger module¶

Logging Module. Module which setsup the basic logging infrustrcuture for the application.

firelink.logger.get_logger(name=None, log_level=20)[source]¶

Set the basic logging features for the application. :param name: The name of the logger. Defaults to None :type name: str, optional :param log_level: The logging level. Defaults to logging.INFO :type log_level: int, optional

Returns

Returns a Logger obejct which is set with the passed in paramters.

Return type

logging.Logger

firelink.pipeline module¶

class firelink.pipeline.FirePipeline(steps)[source]¶

Bases: sklearn.pipeline.Pipeline

wrapper of sklearn pipeline

classmethod link_fire(file)[source]¶

load pickled file

save_fire(file, file_type='ember')[source]¶
steps: List[Any]¶

firelink.replace module¶

class firelink.replace.ConditionalReplace(col, val, cond)[source]¶

Bases: firelink.fire.Firstflame

conidtional statement

transform(X, y=None)[source]¶

firelink.spark_transform module¶

class firelink.spark_transform.ConditionalMapping(col, new_col, val, fill, result)[source]¶

Bases: firelink.fire.Firstflame

conditional mapping

transform(X, y=None)[source]¶

abstract

class firelink.spark_transform.Select(col)[source]¶

Bases: firelink.fire.Firstflame

select

transform(X, y=None)[source]¶

abstract

class firelink.spark_transform.WithColumn(colname, col)[source]¶

Bases: firelink.fire.Firstflame

with column

transform(X, y=None)[source]¶

abstract

firelink.transform module¶

Module contents¶

Previous Next

© Copyright 2022, Chengran (Owen) Ouyang.

Built with Sphinx using a theme provided by Read the Docs.