Configuration API Reference¶

{
  "properties": {
    "create": {
      "default": true,
      "description": "Whether to create the resource. If set to `False`, the user can manually call `.create` instead.",
      "title": "Create",
      "type": "boolean"
    },
    "wait": {
      "default": true,
      "description": "Whether to wait for the remote Ray cluster to become ready to accept connections. If set to `False`, the user can manually call `.wait` instead.",
      "title": "Wait",
      "type": "boolean"
    },
    "connect": {
      "default": true,
      "description": "Whether to run `ray.init` against the remote Ray cluster. If set to `False`, the user can manually call `.connect` instead.",
      "title": "Connect",
      "type": "boolean"
    },
    "cleanup": {
      "default": "always",
      "description": "Resource cleanup policy. Determines when the resource should be deleted after Dagster step execution or during interruption.",
      "enum": [
        "never",
        "always",
        "on_exception"
      ],
      "title": "Cleanup",
      "type": "string"
    }
  },
  "title": "Lifecycle",
  "type": "object"
}

{
  "$defs": {
    "ExecutionOptionsConfig": {
      "properties": {
        "cpu": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Cpu"
        },
        "gpu": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Gpu"
        },
        "object_store_memory": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Object Store Memory"
        }
      },
      "title": "ExecutionOptionsConfig",
      "type": "object"
    }
  },
  "properties": {
    "execution_options": {
      "$ref": "#/$defs/ExecutionOptionsConfig"
    },
    "cpu_limit": {
      "default": 5000,
      "title": "Cpu Limit",
      "type": "integer"
    },
    "gpu_limit": {
      "default": 0,
      "title": "Gpu Limit",
      "type": "integer"
    },
    "verbose_progress": {
      "default": true,
      "title": "Verbose Progress",
      "type": "boolean"
    },
    "use_polars": {
      "default": true,
      "title": "Use Polars",
      "type": "boolean"
    }
  },
  "title": "RayDataExecutionOptions",
  "type": "object"
}

{
  "properties": {
    "cpu": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cpu"
    },
    "gpu": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Gpu"
    },
    "object_store_memory": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Object Store Memory"
    }
  },
  "title": "ExecutionOptionsConfig",
  "type": "object"
}