module sklapi.sklearn_parameters#

Inheritance diagram of mlinsights.sklapi.sklearn_parameters

Short summary#

module mlinsights.sklapi.sklearn_parameters

Defines class SkLearnParameters.

source on GitHub

Classes#

class

truncated documentation

SkException

custom exception

SkLearnParameters

Defines a class to store parameters of a learner or a transform.

Properties#

property

truncated documentation

Keys

Returns parameter names.

Methods#

method

truncated documentation

__init__

Stores parameters as members of the class itself.

__repr__

usual

to_dict

Returns parameters as a dictionary.

validate

Verifies a parameter and its value.

Documentation#

Defines class SkLearnParameters.

source on GitHub

exception mlinsights.sklapi.sklearn_parameters.SkException#

Bases: Exception

custom exception

source on GitHub

class mlinsights.sklapi.sklearn_parameters.SkLearnParameters(**kwargs)#

Bases: object

Defines a class to store parameters of a learner or a transform.

source on GitHub

Stores parameters as members of the class itself.

source on GitHub

property Keys#

Returns parameter names.

source on GitHub

__init__(**kwargs)#

Stores parameters as members of the class itself.

source on GitHub

__repr__()#

usual

source on GitHub

to_dict()#

Returns parameters as a dictionary.

Returns

dict

source on GitHub

validate(name, value)#

Verifies a parameter and its value.

Parameters
  • name – name

  • value – value

@raises raises SkException if error

source on GitHub