rockfish.actions.dg
rockfish.actions.dg
Attributes
FieldType = Literal['continuous', 'categorical', 'session-key', 'ignore', 'session']
module-attribute
Classes
Config
Configuration for the Train action.
Attributes:
| Name | Type | Description |
|---|---|---|
doppelganger |
DGConfig
|
DoppelGANger configuration. |
encoder |
DatasetConfig
|
Dataset configuration. |
model_ids |
Optional[list[str]]
|
Model IDs for generation. |
model_labels |
LabelDict
|
Additional labels to add to the Model. |
DatasetConfig
Dataset configuration.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
|
metadata |
list[FieldConfig]
|
|
measurements |
list[FieldConfig]
|
|
timestamp |
Optional[TimestampConfig]
|
|
privacy |
Optional[PrivacyConfig]
|
|
embedding |
Optional[EmbeddingConfig]
|
|
group_by |
Optional[list]
|
|
DGConfig
DoppelGANger configuration.
Attributes:
| Name | Type | Description |
|---|---|---|
sample_len |
int
|
Concat multiple records as one record in order to make effective session length shorter for training speed and fidelity. |
activate_normalization_per_sample |
bool
|
|
generator_attribute_num_layers |
int
|
|
generator_feature_num_layers |
int
|
|
epoch |
int
|
Number of training epochs. |
epoch_checkpoint_freq |
Optional[int]
|
Deprecated: checkpointing is now automatic. |
g_lr |
float
|
Learning rate for the generator. |
d_lr |
float
|
Learning rate for the discriminator. |
attr_d_beta1 |
float
|
Beta1 of adam optimizer for the metadata discriminator. |
sessions |
Optional[int]
|
Number of sessions to generate. |
EmbeddingConfig
Embedding configuration.
Attributes:
| Name | Type | Description |
|---|---|---|
type |
Optional[str]
|
|
size |
int
|
|
window |
int
|
|
fields |
Optional[list]
|
|
delimiter |
str
|
|
FieldConfig
Configuration for Dataset fields.
Attributes:
| Name | Type | Description |
|---|---|---|
field |
str
|
Name of the field. |
type |
FieldType
|
Type of the field. |
semantic_type |
Optional[str]
|
Semantic type of the field. |
PrivacyConfig
Privacy configuration.
Attributes:
| Name | Type | Description |
|---|---|---|
fields |
list[str]
|
|
TimestampConfig
Timestamp configuration.
Attributes:
| Name | Type | Description |
|---|---|---|
field |
str
|
|