dataunitylab/json-schema-descriptions · Datasets at Hugging Face

schema stringclasses 471 values	key stringlengths 0 203	description stringlengths 0 4.37k	object stringlengths 2 322k
ray-schema.json	location	Azure location	{"type": "string"}
ray-schema.json	resource_group	Azure resource group	{"type": "string"}
ray-schema.json	tags	Azure user-defined tags	{"type": "object"}
ray-schema.json	subscription_id	Azure subscription id	{"type": "string"}
ray-schema.json	msi_identity_id	User-defined managed identity (generated by config)	{"type": "string"}
ray-schema.json	msi_identity_principal_id	User-defined managed identity principal id (generated by config)	{"type": "string"}
ray-schema.json	subnet_id	Network subnet id	{"type": "string"}
ray-schema.json	autoscaler_service_account	k8s autoscaler permissions, if using k8s	{"type": "object"}
ray-schema.json	autoscaler_role	k8s autoscaler permissions, if using k8s	{"type": "object"}
ray-schema.json	autoscaler_role_binding	k8s autoscaler permissions, if using k8s	{"type": "object"}
ray-schema.json	cache_stopped_nodes	Whether to try to reuse previously stopped nodes instead of launching nodes. This will also cause the autoscaler to stop nodes instead of terminating them. Only implemented for AWS.	{"type": "boolean"}
ray-schema.json	availability_zone	GCP availability zone	{"type": "string"}
ray-schema.json	project_id	GCP globally unique project id	{"type": ["string", "null"]}
ray-schema.json	security_group	AWS security group	{"type": "object", "additionalProperties": false, "properties": {"GroupName": {"type": "string"}, "IpPermissions": {"type": "array"}}}
ray-schema.json	GroupName	Security group name	{"type": "string"}
ray-schema.json	IpPermissions	Security group in bound rules	{"type": "array"}
ray-schema.json	disable_node_updaters	Disables node updaters if set to True. Default is False. (For Kubernetes operator usage.)	{"type": "boolean"}
ray-schema.json	gcp_credentials	Credentials for authenticating with the GCP client	{"type": "object", "required": ["type"], "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["credentials_token", "service_account"]}, "credentials": {"type": "string"}}}
ray-schema.json	type	Credentials type: either temporary OAuth 2.0 token or permanent service account credentials blob.	{"type": "string", "enum": ["credentials_token", "service_account"]}
ray-schema.json	credentials	Oauth token or JSON string constituting service account credentials	{"type": "string"}
ray-schema.json	CLOUDWATCH_AGENT_INSTALLED_AMI_TAG	Tag to be added to cloudwatch agent pre-installed AMI name.	{"type": ["string"]}
ray-schema.json	config	Path to Unified CloudWatch Agent config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html for additional details.	{"type": ["string", "null"]}
ray-schema.json	max_attempts	Max allowed Unified CloudWatch Agent installation attempts on any host.	{"type": ["integer", "null"]}
ray-schema.json	delay_seconds	Seconds to wait between each Unified CloudWatch Agent installation attempt.	{"type": ["integer", "null"]}
ray-schema.json	name	User defined CloudWatch Dashboard name.	{"type": ["string", "null"]}
ray-schema.json	config	Path to CloudWatch Dashboard config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html for additional details.	{"type": ["string", "null"]}
ray-schema.json	config	Path to CloudWatch Alarm config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html for additional details.	{"type": ["string", "null"]}
ray-schema.json	auth	How Ray will authenticate with newly launched nodes.	{"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"}}}
ray-schema.json	ssh_proxy_command	A value for ProxyCommand ssh option, for connecting through proxies. Example: nc -x proxy.example.com:1234 %h %p	{"type": "string"}
ray-schema.json	docker	Docker configuration. If this is specified, all setup and start commands will be executed in the container.	{"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}}}
ray-schema.json	image	the docker image name	{"type": "string", "default": "rayproject/ray:latest"}
ray-schema.json	pull_before_run	run `docker pull` first	{"type": "boolean"}
ray-schema.json	run_options	shared options for starting head/worker docker	{"type": "array"}
ray-schema.json	head_image	image for head node, takes precedence over 'image' if specified	{"type": "string"}
ray-schema.json	head_run_options	head specific run options, appended to run_options	{"type": "array"}
ray-schema.json	worker_image	analogous to head_image	{"type": "string"}
ray-schema.json	worker_run_options	analogous to head_run_options	{"type": "array"}
ray-schema.json	disable_automatic_runtime_detection	disable Ray from automatically using the NVIDIA runtime if available	{"type": "boolean", "default": false}
ray-schema.json	disable_shm_size_detection	disable Ray from automatically detecting /dev/shm size for the container	{"type": "boolean", "default": false}
ray-schema.json	use_podman	Use 'podman' command in place of 'docker'	{"type": "boolean", "default": false}
ray-schema.json	head_node_type	If using multiple node types, specifies the head node type.	{"type": "string"}
ray-schema.json	file_mounts	Map of remote paths to local paths, e.g. {"/tmp/data": "/my/local/data"}	{"type": "object"}
ray-schema.json	cluster_synced_files	List of paths on the head node which should sync to the worker nodes, e.g. ["/some/data/somehwere"]	{"type": "array"}
ray-schema.json	file_mounts_sync_continuously	If enabled, file mounts will sync continously between the head node and the worker nodes. The nodes will not re-run setup commands if only the contents of the file mounts folders change.	{"type": "boolean"}
ray-schema.json	rsync_exclude	File pattern to not sync up or down when using the rsync command. Matches the format of rsync's --exclude param.	{"type": "array"}
ray-schema.json	rsync_filter	Pattern files to lookup patterns to exclude when using rsync up or rsync down. This file is checked for recursively in all directories. For example, if .gitignore is provided here, the behavior will match git's .gitignore behavior.	{"type": "array"}
ray-schema.json	metadata	Metadata field that can be used to store user-defined data in the cluster config. Ray does not interpret these fields.	{"type": "object"}
ray-schema.json	initialization_commands	List of commands that will be run before `setup_commands`. If docker is enabled, these commands will run outside the container and before docker is setup.	{}
ray-schema.json	setup_commands	List of common shell commands to run to setup nodes.	{}
ray-schema.json	head_setup_commands	Commands that will be run on the head node after common setup.	{}
ray-schema.json	worker_setup_commands	Commands that will be run on worker nodes after common setup.	{}
ray-schema.json	head_start_ray_commands	Command to start ray on the head node. You shouldn't need to modify this.	{}
ray-schema.json	worker_start_ray_commands	Command to start ray on worker nodes. You shouldn't need to modify this.	{}
ray-schema.json	no_restart	Whether to avoid restarting the cluster during updates. This field is controlled by the ray --no-restart flag and cannot be set by the user.	{}
ray-schema.json	available_node_types	A list of node types for multi-node-type autoscaling.	{"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	node_config	Provider-specific config for the node, e.g. instance type.	{"type": "object"}
ray-schema.json	initialization_commands	List of commands that will be run before `setup_commands`. If docker is enabled, these commands will run outside the container and before docker is setup.	{}
ray-schema.json	worker_setup_commands	List of common shell commands to run to setup nodes. This node specfic list will override the global setup_commands and worker_setup_commands.	{}
ray-schema.json	docker	Configuration of Worker nodes.	{"type": "object", "properties": {"pull_before_run": {"type": "boolean"}, "worker_image": {"type": "string"}, "worker_run_options": {"type": "array"}}, "additionalProperties": false}
ray-schema.json	pull_before_run	run `docker pull` first	{"type": "boolean"}
ray-schema.json	worker_image	analogous to head_image	{"type": "string"}
ray-schema.json	worker_run_options	analogous to head_run_options, merged with the global docker run_options.	{"type": "array"}
rust-project.json	display_name	Crate name used for display purposes, without affecting semantics.	{"type": "string"}
rust-project.json	root_module	Path to the root module of the crate.	{"type": "string"}
rust-project.json	edition	Edition of the crate.	{"type": "string", "enum": ["2015", "2018", "2021"]}
rust-project.json	deps	Crate dependencies.	{"type": "array", "uniqueItems": true, "items": {}}
rust-project.json	version	The crate's version	{"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?$"}
rust-project.json	is_workspace_member	Whether this crate should be treated as a member of the current "workspace".	{"type": "boolean"}
rust-project.json	source	(Super)set of `.rs` files comprising this crate.	{"type": "object", "properties": {"include_dirs": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "exclude_dirs": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}, "required": ["include_dirs", "exclude_dirs"]}
rust-project.json	cfg	The set of cfgs activated for a given crate.	{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
rust-project.json	target	Target triple for this crate.	{"type": "string"}
rust-project.json	env	Environment variables, used for the `env!` macro	{"type": "object", "patternProperties": {"^.*$": {"type": "string"}}, "additionalProperties": false}
rust-project.json	is_proc_macro	Whether the crate is a proc-macro crate.	{"type": "boolean"}
rust-project.json	proc_macro_dylib_path	For proc-macro crates, path to compiled proc-macro (.so file).	{"type": "string"}
rust-project.json	repository	URL to the source repository of the crate.	{"type": "string"}
rust-project.json	crate	Index of a crate in the `crates` array.	{"type": "integer"}
rust-project.json	name	Name as should appear in the (implicit) `extern crate name` declaration.	{"type": "string"}
rust-project.json	sysroot	Path to sysroot.	{"type": "string"}
rust-project.json	sysroot_src	Path to the directory with source code of sysroot crates.	{"type": "string"}
rust-project.json	crates	The set of crates comprising the current project.	{"type": "array", "uniqueItems": true, "items": {}}
uproject.json		Descriptor for projects. Contains all the information contained within a .uproject file.	{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"BuildConfiguration": {"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}, "BuildTargetType": {"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}, "ModuleDescriptor": {"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}, "PluginReferenceDescriptor": {"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}}, "id": "https://json.schemastore.org/uproject.json", "properties": {"DisableEnginePluginsByDefault": {"type": "boolean", "default": false}, "IsEnterpriseProject": {"type": "boolean", "default": false}, "Category": {"type": "string"}, "EngineAssociation": {"type": "string", "pattern": "(^([0-9]+)\\.([0-9]+)$)\|(^\\{[A-F0-9]{8}(-[A-F0-9]{4}){3}-[A-F0-9]{12}\\}$)"}, "EpicSampleNameHash": {"type": "number"}, "FileVersion": {"type": "number", "default": 3}, "Modules": {"type": "array", "uniqueItems": true, "items": {}}, "Plugins": {"type": "array", "uniqueItems": true, "items": {}}, "PostBuildSteps": {"type": "object"}, "PreBuildSteps": {"type": "object"}, "TargetPlatforms": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}, "required": ["EngineAssociation", "FileVersion"], "type": "object"}
uproject.json	BuildConfiguration	Available build configurations. Mirorred from UnrealTargetConfiguration.	{"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}
uproject.json	BuildTargetType	Enumerates build target types.	{"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}
uproject.json	ModuleDescriptor	Description of a loadable module.	{"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}
uproject.json	AdditionalDependencies	List of additional dependencies for building this module.	{"type": "array", "items": {"type": "string"}}
uproject.json	HasExplicitPlatforms	When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions.	{"type": "boolean", "default": false}
uproject.json	LoadingPhase	When should the module be loaded during the startup sequence? This is sort of an advanced setting.	{"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}
uproject.json	Name	Name of this module.	{"type": "string"}
uproject.json	PlatformAllowList	List of allowed platforms.	{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uproject.json	PlatformDenyList	List of disallowed platforms.	{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uproject.json	ProgramAllowList	List of allowed programs.	{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uproject.json	ProgramDenyList	List of disallowed programs.	{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uproject.json	TargetAllowList	List of allowed targets.	{"type": "array", "uniqueItems": true, "items": {}}
uproject.json	TargetConfigurationAllowList	List of allowed target configurations.	{"type": "array", "uniqueItems": true, "items": {}}
uproject.json	TargetConfigurationDenyList	List of disallowed target configurations.	{"type": "array", "uniqueItems": true, "items": {}}
uproject.json	TargetDenyList	List of disallowed targets.	{"type": "array", "uniqueItems": true, "items": {}}
uproject.json	Type	Usage type of module.	{"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}
uproject.json	PluginReferenceDescriptor	Descriptor for a plugin reference.	{"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}
uproject.json	Enabled	Whether it should be enabled by default.	{"type": "boolean", "default": true}
uproject.json	HasExplicitPlatforms	When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions.	{"type": "boolean", "default": false}

ray-schema.json

location

Azure location

{"type": "string"}

ray-schema.json

resource_group

Azure resource group

{"type": "string"}

ray-schema.json

tags

Azure user-defined tags

{"type": "object"}

ray-schema.json

subscription_id

Azure subscription id

{"type": "string"}

ray-schema.json

msi_identity_id

User-defined managed identity (generated by config)

{"type": "string"}

ray-schema.json

msi_identity_principal_id

User-defined managed identity principal id (generated by config)

{"type": "string"}

ray-schema.json

subnet_id

Network subnet id

{"type": "string"}

ray-schema.json

autoscaler_service_account

k8s autoscaler permissions, if using k8s

{"type": "object"}

ray-schema.json

autoscaler_role

k8s autoscaler permissions, if using k8s

{"type": "object"}

ray-schema.json

autoscaler_role_binding

k8s autoscaler permissions, if using k8s

{"type": "object"}

ray-schema.json

cache_stopped_nodes

Whether to try to reuse previously stopped nodes instead of launching nodes. This will also cause the autoscaler to stop nodes instead of terminating them. Only implemented for AWS.

{"type": "boolean"}

ray-schema.json

availability_zone

GCP availability zone

{"type": "string"}

ray-schema.json

project_id

GCP globally unique project id

{"type": ["string", "null"]}

ray-schema.json

security_group

AWS security group

{"type": "object", "additionalProperties": false, "properties": {"GroupName": {"type": "string"}, "IpPermissions": {"type": "array"}}}

ray-schema.json

GroupName

Security group name

{"type": "string"}

ray-schema.json

IpPermissions

Security group in bound rules

{"type": "array"}

ray-schema.json

disable_node_updaters

Disables node updaters if set to True. Default is False. (For Kubernetes operator usage.)

{"type": "boolean"}

ray-schema.json

gcp_credentials

Credentials for authenticating with the GCP client

{"type": "object", "required": ["type"], "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["credentials_token", "service_account"]}, "credentials": {"type": "string"}}}

ray-schema.json

type

Credentials type: either temporary OAuth 2.0 token or permanent service account credentials blob.

{"type": "string", "enum": ["credentials_token", "service_account"]}

ray-schema.json

credentials

Oauth token or JSON string constituting service account credentials

{"type": "string"}

ray-schema.json

CLOUDWATCH_AGENT_INSTALLED_AMI_TAG

Tag to be added to cloudwatch agent pre-installed AMI name.

{"type": ["string"]}

ray-schema.json

config

Path to Unified CloudWatch Agent config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html for additional details.

{"type": ["string", "null"]}

ray-schema.json

max_attempts

Max allowed Unified CloudWatch Agent installation attempts on any host.

{"type": ["integer", "null"]}

ray-schema.json

delay_seconds

Seconds to wait between each Unified CloudWatch Agent installation attempt.

{"type": ["integer", "null"]}

ray-schema.json

name

User defined CloudWatch Dashboard name.

{"type": ["string", "null"]}

ray-schema.json

config

Path to CloudWatch Dashboard config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html for additional details.

{"type": ["string", "null"]}

ray-schema.json

config

Path to CloudWatch Alarm config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html for additional details.

{"type": ["string", "null"]}

ray-schema.json

auth

How Ray will authenticate with newly launched nodes.

{"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"}}}

ray-schema.json

ssh_proxy_command

A value for ProxyCommand ssh option, for connecting through proxies. Example: nc -x proxy.example.com:1234 %h %p

{"type": "string"}

ray-schema.json

docker

Docker configuration. If this is specified, all setup and start commands will be executed in the container.

{"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}}}

ray-schema.json

image

the docker image name

{"type": "string", "default": "rayproject/ray:latest"}

ray-schema.json

pull_before_run

run `docker pull` first

{"type": "boolean"}

ray-schema.json

run_options

shared options for starting head/worker docker

{"type": "array"}

ray-schema.json

head_image

image for head node, takes precedence over 'image' if specified

{"type": "string"}

ray-schema.json

head_run_options

head specific run options, appended to run_options

{"type": "array"}

ray-schema.json

worker_image

analogous to head_image

{"type": "string"}

ray-schema.json

worker_run_options

analogous to head_run_options

{"type": "array"}

ray-schema.json

disable_automatic_runtime_detection

disable Ray from automatically using the NVIDIA runtime if available

{"type": "boolean", "default": false}

ray-schema.json

disable_shm_size_detection

disable Ray from automatically detecting /dev/shm size for the container

{"type": "boolean", "default": false}

ray-schema.json

use_podman

Use 'podman' command in place of 'docker'

{"type": "boolean", "default": false}

ray-schema.json

head_node_type

If using multiple node types, specifies the head node type.

{"type": "string"}

ray-schema.json

file_mounts

Map of remote paths to local paths, e.g. {"/tmp/data": "/my/local/data"}

{"type": "object"}

ray-schema.json

cluster_synced_files

List of paths on the head node which should sync to the worker nodes, e.g. ["/some/data/somehwere"]

{"type": "array"}

ray-schema.json

file_mounts_sync_continuously

If enabled, file mounts will sync continously between the head node and the worker nodes. The nodes will not re-run setup commands if only the contents of the file mounts folders change.

{"type": "boolean"}

ray-schema.json

rsync_exclude

File pattern to not sync up or down when using the rsync command. Matches the format of rsync's --exclude param.

{"type": "array"}

ray-schema.json

rsync_filter

Pattern files to lookup patterns to exclude when using rsync up or rsync down. This file is checked for recursively in all directories. For example, if .gitignore is provided here, the behavior will match git's .gitignore behavior.

{"type": "array"}

ray-schema.json

metadata

Metadata field that can be used to store user-defined data in the cluster config. Ray does not interpret these fields.

{"type": "object"}

ray-schema.json

initialization_commands

List of commands that will be run before `setup_commands`. If docker is enabled, these commands will run outside the container and before docker is setup.

{}

ray-schema.json

setup_commands

List of common shell commands to run to setup nodes.

{}

ray-schema.json

head_setup_commands

Commands that will be run on the head node after common setup.

{}

ray-schema.json

worker_setup_commands

Commands that will be run on worker nodes after common setup.

{}

ray-schema.json

head_start_ray_commands

Command to start ray on the head node. You shouldn't need to modify this.

{}

ray-schema.json

worker_start_ray_commands

Command to start ray on worker nodes. You shouldn't need to modify this.

{}

ray-schema.json

no_restart

Whether to avoid restarting the cluster during updates. This field is controlled by the ray --no-restart flag and cannot be set by the user.

{}

ray-schema.json

available_node_types

A list of node types for multi-node-type autoscaling.

{"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

node_config

Provider-specific config for the node, e.g. instance type.

{"type": "object"}

ray-schema.json

initialization_commands

List of commands that will be run before `setup_commands`. If docker is enabled, these commands will run outside the container and before docker is setup.

{}

ray-schema.json

worker_setup_commands

List of common shell commands to run to setup nodes. This node specfic list will override the global setup_commands and worker_setup_commands.

{}

ray-schema.json

docker

Configuration of Worker nodes.

{"type": "object", "properties": {"pull_before_run": {"type": "boolean"}, "worker_image": {"type": "string"}, "worker_run_options": {"type": "array"}}, "additionalProperties": false}

ray-schema.json

pull_before_run

run `docker pull` first

{"type": "boolean"}

ray-schema.json

worker_image

analogous to head_image

{"type": "string"}

ray-schema.json

worker_run_options

analogous to head_run_options, merged with the global docker run_options.

{"type": "array"}

rust-project.json

display_name

Crate name used for display purposes, without affecting semantics.

{"type": "string"}

rust-project.json

root_module

Path to the root module of the crate.

{"type": "string"}

rust-project.json

edition

Edition of the crate.

{"type": "string", "enum": ["2015", "2018", "2021"]}

rust-project.json

deps

Crate dependencies.

{"type": "array", "uniqueItems": true, "items": {}}

rust-project.json

version

The crate's version

{"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?$"}

rust-project.json

is_workspace_member

Whether this crate should be treated as a member of the current "workspace".

{"type": "boolean"}

rust-project.json

source

(Super)set of `.rs` files comprising this crate.

{"type": "object", "properties": {"include_dirs": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "exclude_dirs": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}, "required": ["include_dirs", "exclude_dirs"]}

rust-project.json

cfg

The set of cfgs activated for a given crate.

{"type": "array", "uniqueItems": true, "items": {"type": "string"}}

rust-project.json

target

Target triple for this crate.

{"type": "string"}

rust-project.json

env

Environment variables, used for the `env!` macro

{"type": "object", "patternProperties": {"^.*$": {"type": "string"}}, "additionalProperties": false}

rust-project.json

is_proc_macro

Whether the crate is a proc-macro crate.

{"type": "boolean"}

rust-project.json

proc_macro_dylib_path

For proc-macro crates, path to compiled proc-macro (.so file).

{"type": "string"}

rust-project.json

repository

URL to the source repository of the crate.

{"type": "string"}

rust-project.json

crate

Index of a crate in the `crates` array.

{"type": "integer"}

rust-project.json

name

Name as should appear in the (implicit) `extern crate name` declaration.

{"type": "string"}

rust-project.json

sysroot

Path to sysroot.

{"type": "string"}

rust-project.json

sysroot_src

Path to the directory with source code of sysroot crates.

{"type": "string"}

rust-project.json

crates

The set of crates comprising the current project.

{"type": "array", "uniqueItems": true, "items": {}}

uproject.json

Descriptor for projects. Contains all the information contained within a .uproject file.

{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"BuildConfiguration": {"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}, "BuildTargetType": {"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}, "ModuleDescriptor": {"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}, "PluginReferenceDescriptor": {"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}}, "id": "https://json.schemastore.org/uproject.json", "properties": {"DisableEnginePluginsByDefault": {"type": "boolean", "default": false}, "IsEnterpriseProject": {"type": "boolean", "default": false}, "Category": {"type": "string"}, "EngineAssociation": {"type": "string", "pattern": "(^([0-9]+)\\.([0-9]+)$)|(^\\{[A-F0-9]{8}(-[A-F0-9]{4}){3}-[A-F0-9]{12}\\}$)"}, "EpicSampleNameHash": {"type": "number"}, "FileVersion": {"type": "number", "default": 3}, "Modules": {"type": "array", "uniqueItems": true, "items": {}}, "Plugins": {"type": "array", "uniqueItems": true, "items": {}}, "PostBuildSteps": {"type": "object"}, "PreBuildSteps": {"type": "object"}, "TargetPlatforms": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}, "required": ["EngineAssociation", "FileVersion"], "type": "object"}

uproject.json

BuildConfiguration

Available build configurations. Mirorred from UnrealTargetConfiguration.

{"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}

uproject.json

BuildTargetType

Enumerates build target types.

{"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}

uproject.json

ModuleDescriptor

Description of a loadable module.

{"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}

uproject.json

AdditionalDependencies

List of additional dependencies for building this module.

{"type": "array", "items": {"type": "string"}}

uproject.json

HasExplicitPlatforms

When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions.

{"type": "boolean", "default": false}

uproject.json

LoadingPhase

When should the module be loaded during the startup sequence? This is sort of an advanced setting.

{"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}

uproject.json

Name

Name of this module.

{"type": "string"}

uproject.json

PlatformAllowList

List of allowed platforms.

{"type": "array", "uniqueItems": true, "items": {"type": "string"}}

uproject.json

PlatformDenyList

List of disallowed platforms.

{"type": "array", "uniqueItems": true, "items": {"type": "string"}}

uproject.json

ProgramAllowList

List of allowed programs.

{"type": "array", "uniqueItems": true, "items": {"type": "string"}}

uproject.json

ProgramDenyList

List of disallowed programs.

{"type": "array", "uniqueItems": true, "items": {"type": "string"}}

uproject.json

TargetAllowList

List of allowed targets.

{"type": "array", "uniqueItems": true, "items": {}}

uproject.json

TargetConfigurationAllowList

List of allowed target configurations.

{"type": "array", "uniqueItems": true, "items": {}}

uproject.json

TargetConfigurationDenyList

List of disallowed target configurations.

{"type": "array", "uniqueItems": true, "items": {}}

uproject.json

TargetDenyList

List of disallowed targets.

{"type": "array", "uniqueItems": true, "items": {}}

uproject.json

Type

Usage type of module.

{"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}

uproject.json

PluginReferenceDescriptor

Descriptor for a plugin reference.

{"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}

uproject.json

Enabled

Whether it should be enabled by default.

{"type": "boolean", "default": true}

uproject.json

HasExplicitPlatforms

When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions.

{"type": "boolean", "default": false}