ddf.stainer.ShuffleStainer

class ddf.stainer.ShuffleStainer(name='Shuffle')

Stainer to randomly rearrange the rows of the DataFrame

__init__(name='Shuffle')

Constructor for ShuffleStainer

Parameters

name (str, optional) – Name of stainer. Default is “Shuffle”

get_col_type()

Returns the column type that the stainer operates on.

Returns

Column type that the stainer operates on.

Return type

string

get_history()

Compiles history information for this stainer and returns it.

Returns

  • name (str) – Name of stainer.

  • msg (str) – Message for user.

  • time (float) – Time taken to execute the self.transform() method.

get_indices()

Returns the row indices and column indices.

Returns

  • row_idx (int list) – Row indices that the stainer operates on.

  • col_idx (int list) – Column indices that the stainer operates on.

transform(df, rng, row_idx=None, col_idx=None)

Applies staining on the given indices in the provided dataframe.

Parameters

  • df (pd.DataFrame) – Dataframe to be transformed.

  • rng (np.random.BitGenerator) – PCG64 pseudo-random number generator.

  • row_idx (int list, optional) – Unused parameter. All rows will be shuffled regardless

  • col_idx (int list, optional) – Unused parameter. All columns will be shuffled regardless

Returns

  • new_df (pd.DataFrame) – Modified dataframe.

  • row_map (empty dictionary) – Row mapping showing the relationship between the original and new row positions.

  • col_map (empty dictionary) – This stainer does not produce any column mappings.

update_history(message='', time=0)

Used by transform method to set attributes required to display history information

Parameters

  • message (str) – Mesasge to be shown to user about the transformation

  • time (float) – Time taken to perform the transform

Methods

__init__([name])

Constructor for ShuffleStainer

get_col_type()

Returns the column type that the stainer operates on.

get_history()

Compiles history information for this stainer and returns it.

get_indices()

Returns the row indices and column indices.

transform(df, rng[, row_idx, col_idx])

Applies staining on the given indices in the provided dataframe.

update_history([message, time])

Used by transform method to set attributes required to display history information