sup3r.preprocessing.data_handling.exogenous_data_handling.SingleExoDataStep

class SingleExoDataStep(feature, combine_type, model, data)[source]

Bases: dict

Special dictionary class for exogenous_data step

exogenous_data step dictionary for a given model step

Parameters:

  • feature (str) – Name of feature corresponding to data.

  • combine_type (str) – Specifies how the exogenous_data should be used for this step. e.g. “input”, “layer”, “output”. For example, if tis equals “input” the data will be used as input to the forward pass for the model step given by model

  • model (int) – Specifies the model index which will use the data. For example, if model == 1 then the data will be used according to combine_type in the 2nd model step in a MultiStepGan.

  • data (tf.Tensor | np.ndarray) – The data to be used for the given model step.

Methods

clear()

copy()

fromkeys([value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

pop(k[,d])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Attributes

shape

Shape of data array for this model step.
property shape

Shape of data array for this model step.

clear() → None.  Remove all items from D.
copy() → a shallow copy of D
fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values