schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
ruff.json | sections | A list of mappings from section names to modules. By default custom sections are output last, but this can be overridden with `section-order`. | {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
ruff.json | single-line-exclusions | One or more modules to exclude from the single line rule. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | split-on-trailing-comma | If a comma is placed after the last member in a multi-line import, then the imports will never be folded into one line.
See isort's [`split-on-trailing-comma`](https://pycqa.github.io/isort/docs/configuration/options.html#split-on-trailing-comma) option. | {"type": ["boolean", "null"]} |
ruff.json | variables | An override list of tokens to always recognize as a var for `order-by-type` regardless of casing. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | LineLength | The length of a line of text that is considered too long. | {"type": "integer", "format": "uint", "minimum": 0.0} |
ruff.json | max-complexity | The maximum McCabe complexity to allow before triggering `C901` errors. | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | classmethod-decorators | A list of decorators that, when applied to a method, indicate that the method should be treated as a class method (in addition to the builtin `@classmethod`).
For example, Ruff will expect that any method decorated by a decorator in this list takes a `cls` argument as its first argument. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | ignore-names | A list of names (or patterns) to ignore when considering `pep8-naming` violations. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | staticmethod-decorators | A list of decorators that, when applied to a method, indicate that the method should be treated as a static method (in addition to the builtin `@staticmethod`).
For example, Ruff will expect that any method decorated by a decorator in this list has no `self` or `cls` argument. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | keep-runtime-typing | Whether to avoid PEP 585 (`List[int]` -> `list[int]`) and PEP 604 (`Union[str, int]` -> `str | int`) rewrites even if a file imports `from __future__ import annotations`.
This setting is only applicable when the target Python version is below 3.9 and 3.10 respectively, and is most commonly used when working with libraries like Pydantic and FastAPI, which rely on the ability to parse type annotations at runtime. The use of `from __future__ import annotations` causes Python to treat the type annotations as strings, which typically allows for the use of language features that appear in later Python versions but are not yet supported by the current version (e.g., `str | int`). However, libraries that rely on runtime type annotations will break if the annotations are incompatible with the current Python version.
For example, while the following is valid Python 3.8 code due to the presence of `from __future__ import annotations`, the use of `str| int` prior to Python 3.10 will cause Pydantic to raise a `TypeError` at runtime:
```python from __future__ import annotations
import pydantic
class Foo(pydantic.BaseModel): bar: str | int ``` | {"type": ["boolean", "null"]} |
ruff.json | ignore-overlong-task-comments | Whether line-length violations (`E501`) should be triggered for comments starting with `task-tags` (by default: \["TODO", "FIXME", and "XXX"\]). | {"type": ["boolean", "null"]} |
ruff.json | max-doc-length | The maximum line length to allow for line-length violations within documentation (`W505`), including standalone comments. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | convention | Whether to use Google-style or NumPy-style conventions or the PEP257 defaults when analyzing docstring sections. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | ignore-decorators | Ignore docstrings for functions or methods decorated with the specified fully-qualified decorators. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | property-decorators | A list of decorators that, when applied to a method, indicate that the method should be treated as a property (in addition to the builtin `@property` and standard-library `@functools.cached_property`).
For example, Ruff will expect that any method decorated by a decorator in this list can use a non-imperative summary line. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extend-generics | Additional functions or classes to consider generic, such that any subscripts should be treated as type annotation (e.g., `ForeignKey` in `django.db.models.ForeignKey["User"]`. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | allow-magic-value-types | Constant types to ignore when used as "magic values" (see: `PLR2004`). | {"type": ["array", "null"], "items": {}} |
ruff.json | max-args | Maximum number of arguments allowed for a function or method definition (see: `PLR0913`). | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | max-branches | Maximum number of branches allowed for a function or method body (see: `PLR0912`). | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | max-returns | Maximum number of return statements allowed for a function or method body (see `PLR0911`) | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | max-statements | Maximum number of statements allowed for a function or method body (see: `PLR0915`). | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | Quote | Use double quotes. | {"type": "string", "enum": ["double"]} |
ruff.json | Quote | Use single quotes. | {"type": "string", "enum": ["single"]} |
ruff.json | RelativeImportsOrder | Place "closer" imports (fewer `.` characters, most local) before "further" imports (more `.` characters, least local). | {"type": "string", "enum": ["closest-to-furthest"]} |
ruff.json | RelativeImportsOrder | Place "further" imports (more `.` characters, least local) imports before "closer" imports (fewer `.` characters, most local). | {"type": "string", "enum": ["furthest-to-closest"]} |
ruff.json | Strictness | Ban imports that extend into the parent module or beyond. | {"type": "string", "enum": ["parents"]} |
ruff.json | Strictness | Ban all relative imports. | {"type": "string", "enum": ["all"]} |
ruff.json | TabSize | The size of a tab. | {"type": "integer", "format": "uint8", "minimum": 0.0} |
ruff.json | allowed-confusables | A list of allowed "confusable" Unicode characters to ignore when enforcing `RUF001`, `RUF002`, and `RUF003`. | {"type": ["array", "null"], "items": {"type": "string", "maxLength": 1, "minLength": 1}} |
ruff.json | builtins | A list of builtins to treat as defined references, in addition to the system builtins. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | cache-dir | A path to the cache directory.
By default, Ruff stores cache results in a `.ruff_cache` directory in the current project root.
However, Ruff will also respect the `RUFF_CACHE_DIR` environment variable, which takes precedence over that default.
This setting will override even the `RUFF_CACHE_DIR` environment variable, if set. | {"type": ["string", "null"]} |
ruff.json | dummy-variable-rgx | A regular expression used to identify "dummy" variables, or those which should be ignored when enforcing (e.g.) unused-variable rules. The default expression matches `_`, `__`, and `_var`, but not `_var_`. | {"type": ["string", "null"]} |
ruff.json | exclude | A list of file patterns to exclude from linting.
Exclusions are based on globs, and can be either:
- Single-path patterns, like `.mypy_cache` (to exclude any directory named `.mypy_cache` in the tree), `foo.py` (to exclude any file named `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ). - Relative patterns, like `directory/foo.py` (to exclude that specific file) or `directory/*.py` (to exclude any Python files in `directory`). Note that these paths are relative to the project root (e.g., the directory containing your `pyproject.toml`).
For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).
Note that you'll typically want to use [`extend-exclude`](#extend-exclude) to modify the excluded paths. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extend | A path to a local `pyproject.toml` file to merge into this configuration. User home directory and environment variables will be expanded.
To resolve the current `pyproject.toml` file, Ruff will first resolve this base configuration file, then merge in any properties defined in the current configuration file. | {"type": ["string", "null"]} |
ruff.json | extend-exclude | A list of file patterns to omit from linting, in addition to those specified by `exclude`.
Exclusions are based on globs, and can be either:
- Single-path patterns, like `.mypy_cache` (to exclude any directory named `.mypy_cache` in the tree), `foo.py` (to exclude any file named `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ). - Relative patterns, like `directory/foo.py` (to exclude that specific file) or `directory/*.py` (to exclude any Python files in `directory`). Note that these paths are relative to the project root (e.g., the directory containing your `pyproject.toml`).
For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax). | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extend-fixable | A list of rule codes or prefixes to consider autofixable, in addition to those specified by `fixable`. | {"type": ["array", "null"], "items": {}} |
ruff.json | extend-include | A list of file patterns to include when linting, in addition to those specified by `include`.
Inclusion are based on globs, and should be single-path patterns, like `*.pyw`, to include any file with the `.pyw` extension.
For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax). | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extend-per-file-ignores | A list of mappings from file pattern to rule codes or prefixes to exclude, in addition to any rules excluded by `per-file-ignores`. | {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {}}} |
ruff.json | extend-select | A list of rule codes or prefixes to enable, in addition to those specified by `select`. | {"type": ["array", "null"], "items": {}} |
ruff.json | external | A list of rule codes that are unsupported by Ruff, but should be preserved when (e.g.) validating `# noqa` directives. Useful for retaining `# noqa` directives that cover plugins not yet implemented by Ruff. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | fix | Enable autofix behavior by-default when running `ruff` (overridden by the `--fix` and `--no-fix` command-line flags). | {"type": ["boolean", "null"]} |
ruff.json | fix-only | Like `fix`, but disables reporting on leftover violation. Implies `fix`. | {"type": ["boolean", "null"]} |
ruff.json | fixable | A list of rule codes or prefixes to consider autofixable. By default, all rules are considered autofixable. | {"type": ["array", "null"], "items": {}} |
ruff.json | flake8-annotations | Options for the `flake8-annotations` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-bandit | Options for the `flake8-bandit` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-bugbear | Options for the `flake8-bugbear` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-builtins | Options for the `flake8-builtins` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-comprehensions | Options for the `flake8-comprehensions` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-copyright | Options for the `copyright` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-errmsg | Options for the `flake8-errmsg` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-gettext | Options for the `flake8-gettext` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-implicit-str-concat | Options for the `flake8-implicit-str-concat` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-import-conventions | Options for the `flake8-import-conventions` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-pytest-style | Options for the `flake8-pytest-style` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-quotes | Options for the `flake8-quotes` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-self | Options for the `flake8_self` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-tidy-imports | Options for the `flake8-tidy-imports` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-type-checking | Options for the `flake8-type-checking` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | flake8-unused-arguments | Options for the `flake8-unused-arguments` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | force-exclude | Whether to enforce `exclude` and `extend-exclude` patterns, even for paths that are passed to Ruff explicitly. Typically, Ruff will lint any paths passed in directly, even if they would typically be excluded. Setting `force-exclude = true` will cause Ruff to respect these exclusions unequivocally.
This is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all changed files to the [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit) plugin, regardless of whether they're marked as excluded by Ruff's own settings. | {"type": ["boolean", "null"]} |
ruff.json | format | The style in which violation messages should be formatted: `"text"` (default), `"grouped"` (group messages by file), `"json"` (machine-readable), `"junit"` (machine-readable XML), `"github"` (GitHub Actions annotations), `"gitlab"` (GitLab CI code quality report), `"pylint"` (Pylint text format) or `"azure"` (Azure Pipeline logging commands). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | ignore | A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.
When breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. | {"type": ["array", "null"], "items": {}} |
ruff.json | ignore-init-module-imports | Avoid automatically removing unused imports in `__init__.py` files. Such imports will still be flagged, but with a dedicated message suggesting that the import is either added to the module's `__all__` symbol, or re-exported with a redundant alias (e.g., `import os as os`). | {"type": ["boolean", "null"]} |
ruff.json | include | A list of file patterns to include when linting.
Inclusion are based on globs, and should be single-path patterns, like `*.pyw`, to include any file with the `.pyw` extension. `pyproject.toml` is included here not for configuration but because we lint whether e.g. the `[project]` matches the schema.
For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax). | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | isort | Options for the `isort` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | line-length | The line length to use when enforcing long-lines violations (like `E501`). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | mccabe | Options for the `mccabe` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | namespace-packages | Mark the specified directories as namespace packages. For the purpose of module resolution, Ruff will treat those directories as if they contained an `__init__.py` file. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | pep8-naming | Options for the `pep8-naming` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | per-file-ignores | A list of mappings from file pattern to rule codes or prefixes to exclude, when considering any matching files. | {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {}}} |
ruff.json | pycodestyle | Options for the `pycodestyle` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | pydocstyle | Options for the `pydocstyle` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | pyflakes | Options for the `pyflakes` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | pylint | Options for the `pylint` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | pyupgrade | Options for the `pyupgrade` plugin. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | required-version | Require a specific version of Ruff to be running (useful for unifying results across many environments, e.g., with a `pyproject.toml` file). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | respect-gitignore | Whether to automatically exclude files that are ignored by `.ignore`, `.gitignore`, `.git/info/exclude`, and global `gitignore` files. Enabled by default. | {"type": ["boolean", "null"]} |
ruff.json | select | A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.
When breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. | {"type": ["array", "null"], "items": {}} |
ruff.json | show-fixes | Whether to show an enumeration of all autofixed lint violations (overridden by the `--show-fixes` command-line flag). | {"type": ["boolean", "null"]} |
ruff.json | show-source | Whether to show source code snippets when reporting lint violations (overridden by the `--show-source` command-line flag). | {"type": ["boolean", "null"]} |
ruff.json | src | The source code paths to consider, e.g., when resolving first- vs. third-party imports.
As an example: given a Python package structure like:
```text my_package/ pyproject.toml src/ my_package/ __init__.py foo.py bar.py ```
The `src` directory should be included in the `src` option (e.g., `src = ["src"]`), such that when resolving imports, `my_package.foo` is considered a first-party import.
When omitted, the `src` directory will typically default to the directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the "project root"), unless a configuration file is explicitly provided (e.g., via the `--config` command-line flag).
This field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = ["python_modules/*"]` would expand to incorporate all of the packages in that directory. User home directory and environment variables will also be expanded. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | tab-size | The tabulation size to calculate line length. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | target-version | The minimum Python version to target, e.g., when considering automatic code upgrades, like rewriting type annotations.
If omitted, and Ruff is configured via a `pyproject.toml` file, the target version will be inferred from its `project.requires-python` field (e.g., `requires-python = ">=3.8"`). If Ruff is configured via `ruff.toml` or `.ruff.toml`, no such inference will be performed. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | task-tags | A list of task tags to recognize (e.g., "TODO", "FIXME", "XXX").
Comments starting with these tags will be ignored by commented-out code detection (`ERA`), and skipped by line-length rules (`E501`) if `ignore-overlong-task-comments` is set to `true`. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | typing-modules | A list of modules whose imports should be treated equivalently to members of the `typing` module.
This is useful for ensuring proper type annotation inference for projects that re-export `typing` and `typing_extensions` members from a compatibility module. If omitted, any members imported from modules apart from `typing` and `typing_extensions` will be treated as ordinary Python objects. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | unfixable | A list of rule codes or prefixes to consider non-autofix-able. | {"type": ["array", "null"], "items": {}} |
ray-schema.json | Ray autoscaler schema | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {"commands": {"type": "array", "items": {"type": "string"}}}, "required": ["cluster_name", "provider"], "additionalProperties": false, "properties": {"cluster_name": {"type": "string"}, "max_workers": {"type": "integer", "minimum": 0}, "upscaling_speed": {"type": "number", "minimum": 0}, "idle_timeout_minutes": {"type": "number", "minimum": 0}, "provider": {"type": "object", "required": ["type"], "additionalProperties": true, "properties": {"type": {"type": "string"}, "region": {"type": "string"}, "module": {"type": "string"}, "head_ip": {"type": "string"}, "worker_ips": {"type": "array"}, "use_internal_ips": {"type": "boolean"}, "namespace": {"type": "string"}, "location": {"type": "string"}, "resource_group": {"type": "string"}, "tags": {"type": "object"}, "subscription_id": {"type": "string"}, "msi_identity_id": {"type": "string"}, "msi_identity_principal_id": {"type": "string"}, "subnet_id": {"type": "string"}, "autoscaler_service_account": {"type": "object"}, "autoscaler_role": {"type": "object"}, "autoscaler_role_binding": {"type": "object"}, "cache_stopped_nodes": {"type": "boolean"}, "availability_zone": {"type": "string"}, "project_id": {"type": ["string", "null"]}, "security_group": {"type": "object", "additionalProperties": false, "properties": {"GroupName": {"type": "string"}, "IpPermissions": {"type": "array"}}}, "disable_node_updaters": {"type": "boolean"}, "gcp_credentials": {"type": "object", "required": ["type"], "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["credentials_token", "service_account"]}, "credentials": {"type": "string"}}}, "cloudwatch": {"agent": {"CLOUDWATCH_AGENT_INSTALLED_AMI_TAG": {"type": ["string"]}, "config": {"type": ["string", "null"]}, "retryer": {"max_attempts": {"type": ["integer", "null"]}, "delay_seconds": {"type": ["integer", "null"]}}}, "dashboard": {"name": {"type": ["string", "null"]}, "config": {"type": ["string", "null"]}}, "alarm": {"config": {"type": ["string", "null"]}}}}}, "auth": {"type": "object", "additionalProperties": false, "properties": {"ssh_user": {"type": "string", "default": "ubuntu"}, "ssh_public_key": {"type": "string"}, "ssh_private_key": {"type": "string"}, "ssh_proxy_command": {"type": "string"}}}, "docker": {"type": "object", "additionalProperties": false, "properties": {"image": {"type": "string", "default": "rayproject/ray:latest"}, "container_name": {"type": "string", "default": "ray_docker"}, "pull_before_run": {"type": "boolean"}, "run_options": {"type": "array"}, "head_image": {"type": "string"}, "head_run_options": {"type": "array"}, "worker_image": {"type": "string"}, "worker_run_options": {"type": "array"}, "disable_automatic_runtime_detection": {"type": "boolean", "default": false}, "disable_shm_size_detection": {"type": "boolean", "default": false}, "use_podman": {"type": "boolean", "default": false}}}, "head_node_type": {"type": "string"}, "file_mounts": {"type": "object"}, "cluster_synced_files": {"type": "array"}, "file_mounts_sync_continuously": {"type": "boolean"}, "rsync_exclude": {"type": "array"}, "rsync_filter": {"type": "array"}, "metadata": {"type": "object"}, "initialization_commands": {}, "setup_commands": {}, "head_setup_commands": {}, "worker_setup_commands": {}, "head_start_ray_commands": {}, "worker_start_ray_commands": {}, "no_restart": {}, "available_node_types": {"type": "object", "patternProperties": {".*": {"type": "object", "required": ["resources", "node_config"], "properties": {"node_config": {"type": "object"}, "min_workers": {"type": "integer"}, "max_workers": {"type": "integer"}, "resources": {"type": "object", "patternProperties": {".*": {"type": "integer", "minimum": 0}}}, "labels": {"type": "object", "patternProperties": {".*": {"type": "string"}}}, "initialization_commands": {}, "worker_setup_commands": {}, "docker": {"type": "object", "properties": {"pull_before_run": {"type": "boolean"}, "worker_image": {"type": "string"}, "worker_run_options": {"type": "array"}}, "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": false}}} |
|
ray-schema.json | items | shell command | {"type": "string"} |
ray-schema.json | cluster_name | A unique identifier for the head node and workers of this cluster. | {"type": "string"} |
ray-schema.json | max_workers | The maximum number of workers nodes to launch in addition to the head node. This takes precedence over min_workers. | {"type": "integer", "minimum": 0} |
ray-schema.json | upscaling_speed | The autoscaler will scale up the cluster faster with higher upscaling speed. E.g., if the task requires adding more nodes then autoscaler will gradually scale up the cluster in chunks of upscaling_speed*currently_running_nodes. This number should be > 0. | {"type": "number", "minimum": 0} |
ray-schema.json | idle_timeout_minutes | If a node is idle for this many minutes, it will be removed. | {"type": "number", "minimum": 0} |
ray-schema.json | provider | Cloud-provider specific configuration. | {"type": "object", "required": ["type"], "additionalProperties": true, "properties": {"type": {"type": "string"}, "region": {"type": "string"}, "module": {"type": "string"}, "head_ip": {"type": "string"}, "worker_ips": {"type": "array"}, "use_internal_ips": {"type": "boolean"}, "namespace": {"type": "string"}, "location": {"type": "string"}, "resource_group": {"type": "string"}, "tags": {"type": "object"}, "subscription_id": {"type": "string"}, "msi_identity_id": {"type": "string"}, "msi_identity_principal_id": {"type": "string"}, "subnet_id": {"type": "string"}, "autoscaler_service_account": {"type": "object"}, "autoscaler_role": {"type": "object"}, "autoscaler_role_binding": {"type": "object"}, "cache_stopped_nodes": {"type": "boolean"}, "availability_zone": {"type": "string"}, "project_id": {"type": ["string", "null"]}, "security_group": {"type": "object", "additionalProperties": false, "properties": {"GroupName": {"type": "string"}, "IpPermissions": {"type": "array"}}}, "disable_node_updaters": {"type": "boolean"}, "gcp_credentials": {"type": "object", "required": ["type"], "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["credentials_token", "service_account"]}, "credentials": {"type": "string"}}}, "cloudwatch": {"agent": {"CLOUDWATCH_AGENT_INSTALLED_AMI_TAG": {"type": ["string"]}, "config": {"type": ["string", "null"]}, "retryer": {"max_attempts": {"type": ["integer", "null"]}, "delay_seconds": {"type": ["integer", "null"]}}}, "dashboard": {"name": {"type": ["string", "null"]}, "config": {"type": ["string", "null"]}}, "alarm": {"config": {"type": ["string", "null"]}}}}} |
ray-schema.json | type | e.g. aws, azure, gcp,... | {"type": "string"} |
ray-schema.json | region | e.g. us-east-1 | {"type": "string"} |
ray-schema.json | module | module, if using external node provider | {"type": "string"} |
ray-schema.json | head_ip | gcp project id, if using gcp | {"type": "string"} |
ray-schema.json | worker_ips | local cluster head node | {"type": "array"} |
ray-schema.json | use_internal_ips | don't require public ips | {"type": "boolean"} |
ray-schema.json | namespace | k8s namespace, if using k8s | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.