The Python engine allows you to execute Python code interacting with the partition from inside a Model Class logic.
Supported Versions
When using the Python engine in production, you must specify a version (e.g., not latest but v1).
Each version of the Python engine targets a specific version of the Pricefx platform, as shown in this table:
Python Engine version | Supported Pricefx Platform version |
|---|---|
v1 | 9.4 |
v2 | 9.4 |
v3 | 10.0 |
v4 | 10.1 |
v5 | 10.2 |
v6 | 10.3 |
v7 | 10.3 |
For more details on the changes provided by each version, see the Changelog page.
Partition Configuration
Job Trigger Images Flavors
The following images are available at https://gitlab.pricefx.eu/engineering/pricefx-python-engine/container_registry.
Image | Description |
|---|---|
| Minimal image containing only the |
| Image containing |
| Image containing |
If you have no specific needs, use cregistry.pricefx.eu/engineering/pricefx-python-engine/datascience.
For details on libraries available in each flavour see Images flavour.
Recommended Resources for Job Trigger Configuration
It is recommended to start with the following values:
cpuLimit: 2memoryLimit: 8Gi
Cluster Settings
If your Python script involves downloading/uploading large amounts of data or uploading big attachments to your model, you may need to update the corresponding cluster settings to avoid issues (such as timeout).
Here are the relevant cluster settings to adjust:
Maximum size of model attachments
This can be configured under thebinaryDataServicesection. You should probably increase at least themaxBinarySizeValue.Timeout of requests to data sources
Adjust thedatamart.query.externalDefaultTimeoutanddatamart.query.externalMaxTimeout.
You should create a support ticket to ask those cluster settings modifications.
Python Engine Parameters
The Python engine takes a json-encoded dictionary containing the following fields:
Attribute | Type | Description | Mandatory |
|---|---|---|---|
| String | The script you want to run in the Python engine. | yes |
| Dictionary | Optional, a dictionary of values that will be made accessible from inside the script. | no |
See https://pricefx.atlassian.net/wiki/spaces/KB/pages/4346413172/Run+Python+Scripts#Script-sample for examples on how to declare and use these parameters.
pyfx Python API
From inside the Python script, the pyfx module is available to interact with the partition. Attached is the complete documentation for the versions of the pyfx module.
v1
| View file | ||
|---|---|---|
|
v2
| View file | ||
|---|---|---|
|
v3
| View file | ||
|---|---|---|
|
v4
| View file | ||
|---|---|---|
|
v7
| View file | ||
|---|---|---|
|