ray.serve.config.AutoscalingConfig

pydantic model ray.serve.config.AutoscalingConfig

Config for the Serve Autoscaler.

Show JSON schema

{
   "title": "AutoscalingConfig",
   "description": "Config for the Serve Autoscaler.",
   "type": "object",
   "properties": {
      "min_replicas": {
         "title": "Min Replicas",
         "default": 1,
         "minimum": 0,
         "type": "integer"
      },
      "initial_replicas": {
         "title": "Initial Replicas",
         "minimum": 0,
         "type": "integer"
      },
      "max_replicas": {
         "title": "Max Replicas",
         "default": 1,
         "exclusiveMinimum": 0,
         "type": "integer"
      },
      "target_num_ongoing_requests_per_replica": {
         "title": "Target Num Ongoing Requests Per Replica",
         "description": "[DEPRECATED] Please use `target_ongoing_requests` instead.",
         "default": 1.0,
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "target_ongoing_requests": {
         "title": "Target Ongoing Requests",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "metrics_interval_s": {
         "title": "Metrics Interval S",
         "default": 10.0,
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "look_back_period_s": {
         "title": "Look Back Period S",
         "default": 30.0,
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "smoothing_factor": {
         "title": "Smoothing Factor",
         "default": 1.0,
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "upscale_smoothing_factor": {
         "title": "Upscale Smoothing Factor",
         "description": "[DEPRECATED] Please use `upscaling_factor` instead.",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "downscale_smoothing_factor": {
         "title": "Downscale Smoothing Factor",
         "description": "[DEPRECATED] Please use `downscaling_factor` instead.",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "upscaling_factor": {
         "title": "Upscaling Factor",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "downscaling_factor": {
         "title": "Downscaling Factor",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "downscale_delay_s": {
         "title": "Downscale Delay S",
         "default": 600.0,
         "minimum": 0,
         "type": "number"
      },
      "upscale_delay_s": {
         "title": "Upscale Delay S",
         "default": 30.0,
         "minimum": 0,
         "type": "number"
      }
   }
}

Fields:

• downscale_delay_s (pydantic.types.NonNegativeFloat)

• downscale_smoothing_factor (pydantic.types.PositiveFloat | None)

• downscaling_factor (pydantic.types.PositiveFloat | None)

• initial_replicas (pydantic.types.NonNegativeInt | None)

• look_back_period_s (pydantic.types.PositiveFloat)

• max_replicas (pydantic.types.PositiveInt)

• metrics_interval_s (pydantic.types.PositiveFloat)

• min_replicas (pydantic.types.NonNegativeInt)

• smoothing_factor (pydantic.types.PositiveFloat)

• target_num_ongoing_requests_per_replica (pydantic.types.PositiveFloat)

• target_ongoing_requests (pydantic.types.PositiveFloat | None)

• upscale_delay_s (pydantic.types.NonNegativeFloat)

• upscale_smoothing_factor (pydantic.types.PositiveFloat | None)

• upscaling_factor (pydantic.types.PositiveFloat | None)

Validators:

• replicas_settings_valid » max_replicas

field downscale_delay_s: NonNegativeFloat = 600.0

Constraints:

• minimum = 0

field downscale_smoothing_factor: PositiveFloat | None = None

[DEPRECATED] Please use downscaling_factor instead.

Constraints:

• exclusiveMinimum = 0

field downscaling_factor: PositiveFloat | None = None

Constraints:

• exclusiveMinimum = 0

field initial_replicas: NonNegativeInt | None = None

Constraints:

• minimum = 0

field look_back_period_s: PositiveFloat = 30.0

Constraints:

• exclusiveMinimum = 0

field max_replicas: PositiveInt = 1

Constraints:

• exclusiveMinimum = 0

Validated by:

• replicas_settings_valid

field metrics_interval_s: PositiveFloat = 10.0

Constraints:

• exclusiveMinimum = 0

field min_replicas: NonNegativeInt = 1

Constraints:

• minimum = 0

field smoothing_factor: PositiveFloat = 1.0

Constraints:

• exclusiveMinimum = 0

field target_num_ongoing_requests_per_replica: PositiveFloat = 1.0

[DEPRECATED] Please use target_ongoing_requests instead.

Constraints:

• exclusiveMinimum = 0

field target_ongoing_requests: PositiveFloat | None = None

Constraints:

• exclusiveMinimum = 0

field upscale_delay_s: NonNegativeFloat = 30.0

Constraints:

• minimum = 0

field upscale_smoothing_factor: PositiveFloat | None = None

[DEPRECATED] Please use upscaling_factor instead.

Constraints:

• exclusiveMinimum = 0

field upscaling_factor: PositiveFloat | None = None

Constraints:

• exclusiveMinimum = 0

classmethod default()

get_downscaling_factor() → PositiveFloat

get_policy() → Callable

Deserialize policy from cloudpickled bytes.

get_target_ongoing_requests() → PositiveFloat

get_upscaling_factor() → PositiveFloat

validator replicas_settings_valid  »  max_replicas

serialize_policy() → None

Serialize policy with cloudpickle.

Import the policy if it’s passed in as a string import path. Then cloudpickle the policy and set serialized_policy_def if it’s empty.