api#

datagen.api.create_datapoint(human: Human, camera: Camera, glasses: Optional[Glasses] = None, mask: Optional[Mask] = None, background: Optional[Background] = None, lights: Optional[List[Light]] = None) HumanDatapoint#

Puts together all of the parts of a datapoint, for inclusion in your data request.

Parameters:
Returns:

A formatted datapoint for inclusion in your datagen.api.assets.DataRequest.

Return type:

datagen.api.assets.HumanDatapoint

datagen.api.dump(request: DataRequest, path: Optional[str] = None) None#

Generates a JSON file from a datagen.api.assets.DataRequest object

Parameters:
  • request (datagen.api.assets.DataRequest) – Your data request, containing instructions for generating one or more datapoints

  • path (str) – The output path for the file. Must use a .json extension. Optional, defaults to “datagen_data_request.json”.

Returns:

None

datagen.api.load(path: str) DataRequest#

Creates a DataRequest object from an existing JSON file.

Parameters:

path (str) – The path to the JSON file.

Returns:

A DataRequest object containing all of the datapoints in the loaded file.

Return type:

datagen.api.assets.DataRequest