Job Results
- class gretel_client.gretel.job_results.GenerateJobResults(project: Project, model: Model, record_handler: RecordHandler, synthetic_data_link: str | None = None, synthetic_data: DataFrame | None = None)
Dataclass for the results from a Gretel data generation job.
- property record_id: str
The ID of the job that generated the requested data.
- refresh()
Refresh the generate job results attributes.
- wait_for_completion()
Wait for the model to finish generating data.
- class gretel_client.gretel.job_results.GretelJobResults(project: Project, model: Model)
Base class for Gretel jobs.
- class gretel_client.gretel.job_results.TrainJobResults(project: Project, model: Model, model_config: dict | None = None, report: GretelReport | None = None, model_logs: List[dict] | None = None)
Dataclass for the results from a Gretel model training job.
- fetch_report_synthetic_data() DataFrame
Fetch synthetic data generated for the report and return as a DataFrame.
Note: This method requires the pandas package to be installed.
- refresh()
Refresh the training job results attributes.
- wait_for_completion()
Wait for the model to finish training.
- class gretel_client.gretel.job_results.TransformResults(project: Project, model: Model, transform_logs: List[dict] | None = None, transformed_df: DataFrame | None = None, transformed_data_link: str | None = None)
Should not be used directly.
Stores metadata and a transformed DataFrame that was created from a Gretel Transforms job.
- property job_status: Status
The current status of the transform job.
- property model_config: str
The Transforms config that was used.
- property model_url: str
The Gretel Console URL for the Transform model.
- refresh() None
Refresh the transform job result attributes.
- transform_logs: List[dict] | None = None
Logs created during Transform job.
- transformed_data_link: str | None = None
URI to the transformed data (as a flat file). This will not be populated until the transforms job succeeds.
- transformed_df: DataFrame | None = None
A DataFrame of the transformed table. This will not be populated until the trasnforms job succeeds.
- wait_for_completion() None
Wait for transforms job to finish running.