nemo_microservices.types.data_designer.person_sampler_params

Module Contents

Classes

PersonSamplerParams

API

class nemo_microservices.types.data_designer.person_sampler_params.PersonSamplerParams(/, **data: typing.Any)

Bases: nemo_microservices._models.BaseModel

age_range: Optional[List[int]]

None

If specified, then only synthetic people within this age range will be sampled.

city: Union[str, List[str], None]

None

If specified, then only synthetic people from these cities will be sampled.

locale: Optional[str]

None

Locale that determines the language and geographic location that a synthetic person will be sampled from. Must be a locale supported by a managed Nemotron Personas dataset. Managed datasets exist for the following locales: en_US, ja_JP, en_IN, hi_IN.

sampler_type: Optional[typing_extensions.Literal[person]]

None

select_field_values: Optional[Dict[str, List[str]]]

None

Sample synthetic people with the specified field values.

This is meant to be a flexible argument for selecting a subset of the population from the managed dataset. Note that this sampler does not support rare combinations of field values and will likely fail if your desired subset is not well-represented in the managed Nemotron Personas dataset. We generally recommend using the sex, city, and age_range arguments to filter the population when possible.

sex: Optional[str]

None

If specified, then only synthetic people of the specified sex will be sampled.

with_synthetic_personas: Optional[bool]

None

If True, then append synthetic persona columns to each generated person.