nemo_microservices.data_designer.config.base#

Module Contents#

Classes#

ConfigBase

DataDesignerInterface

ExportableConfigBase

ResultsProtocol

Data#

DEFAULT_NUM_RECORDS

ResultsT

API#

class nemo_microservices.data_designer.config.base.ConfigBase(/, **data: Any)#

Bases: pydantic.BaseModel

model_config#

‘ConfigDict(…)’

nemo_microservices.data_designer.config.base.DEFAULT_NUM_RECORDS#

10

class nemo_microservices.data_designer.config.base.DataDesignerInterface#

Bases: abc.ABC, typing.Generic[nemo_microservices.data_designer.config.base.ResultsT]

abstract create(
config_builder: nemo_microservices.data_designer.config.config_builder.DataDesignerConfigBuilder,
*,
num_records: int = DEFAULT_NUM_RECORDS,
) → nemo_microservices.data_designer.config.base.ResultsT#
abstract preview(
config_builder: nemo_microservices.data_designer.config.config_builder.DataDesignerConfigBuilder,
*,
num_records: int = DEFAULT_NUM_RECORDS,
) → nemo_microservices.data_designer.client.results.preview.PreviewResults#
class nemo_microservices.data_designer.config.base.ExportableConfigBase(/, **data: Any)#

Bases: nemo_microservices.data_designer.config.base.ConfigBase

to_dict() → dict[str, Any]#

Convert the configuration to a dictionary.

Returns: A dictionary representation of the configuration using JSON-compatible serialization.

to_json(
path: str | pathlib.Path | None = None,
*,
indent: int | None = 2,
**kwargs,
) → str | None#

Convert the configuration to a JSON string or file.

Args: path: Optional file path to write the JSON to. If None, returns the JSON string instead of writing to file. indent: Number of spaces for JSON indentation. Defaults to 2. **kwargs: Additional keyword arguments passed to json.dumps().

Returns: The JSON string if path is None, otherwise None (file is written).

to_yaml(
path: str | pathlib.Path | None = None,
*,
indent: int | None = 2,
**kwargs,
) → str | None#

Convert the configuration to a YAML string or file.

Args: path: Optional file path to write the YAML to. If None, returns the YAML string instead of writing to file. indent: Number of spaces for YAML indentation. Defaults to 2. **kwargs: Additional keyword arguments passed to yaml.dump().

Returns: The YAML string if path is None, otherwise None (file is written).

class nemo_microservices.data_designer.config.base.ResultsProtocol#

Bases: typing.Protocol

load_analysis() → nemo_microservices.data_designer.config.analysis.dataset_profiler.DatasetProfilerResults#
load_dataset() → pandas.DataFrame#
nemo_microservices.data_designer.config.base.ResultsT#

‘TypeVar(…)’