o bi; @sUdZddlZddlmZddlmZmZmZmZm Z m Z ddl Z ddl m Z ddlmZddlmZddlmZdd lmZmZmZeGd d d ZdUd ededefddZddZdVd edefddZdeeeefdeefddZidee e!dfdddeee!dfdedd eee!dfdedd ed d!ed!d"d#ee!deefd$d%d&ee"d'd%d(eee!dfdee e!dfd)dd*ee e!dfd+ee!deeeefd,ee e!dfd-eed d%d.ee e!dfZ#d/ed0e!defd1d2Z$ed3d"dd%ed4e j%d%edd5d%ee"ee!dfd6ddd%ee"e!dfd7deee&e'fd8dd"d%ee"e!dfd9dd:Z(ee&e e!dfeee!dfd;deddd%ed?d'd%eee!dfeed"d%d@Z)ie(e)e#Z*eeefe+dA<ie#e(Z,eeefe+dB<ie#e)Z-eeefe+dC<dDe&e*.dEZ/dFeeeffdGdHZ0dFeeefdIe"fdJdKZ1dFeeefdLefdMdNZ2dFeeefdLefdOdPZ3dQeeefdReeefdeeeffdSdTZ4dS)WzKManage, parse and validate options for Ray tasks, actors and actor methods.N) dataclass)AnyCallableDictOptionalTupleUnion) ray_constantsvalidate_label_selector)get_ray_doc_version)PlacementGroup)NodeAffinitySchedulingStrategyNodeLabelSchedulingStrategy PlacementGroupSchedulingStrategyc@sfeZdZUdZeeeeefed<dZ ee e gee fed<dZ e ed<de de fddZdS) OptionNtype_constraintvalue_constraint default_valuekeywordvaluecCs^|jdurt||jstd|d|jdt||jdur+||}|r-t|dSdS)zValidate the option.NzThe type of keyword 'z ' must be z, but received type )r isinstance TypeErrortyper ValueError)selfrrpossible_error_messagerQ/home/ubuntu/.local/lib/python3.10/site-packages/ray/_private/ray_option_utils.pyvalidates    zOption.validate)__name__ __module__ __qualname__rrrrr__annotations__rrrstrrrrrrrrs  rTnameinfinitercs@|rtttdffdd|dStttdffdd|dS)zThis is used for positive and discrete options. Args: name: The name of the option keyword. infinite: If True, user could use -1 to represent infinity. default_value: The default value for this option. Nc |dus|dkr dSddS)N The keyword 'zO' only accepts None, 0, -1 or a positive integer, where -1 represents infinity.rxr%rr8 z"_counting_option..rcr')Nrr)z-' only accepts None, 0 or a positive integer.rr*r,rrr-@r.)rintr)r%r&rrr,r_counting_option-s    r1cCs|dkr d|dSt|tr#|dkr#t|tjjdkr#d|dS|dkr)dn|}|tjjvrCtjj | |\}}|sC|SdS) NrzThe quantity of resource z cannot be negativegz5The precision of the fractional quantity of resource z cannot go beyond 0.0001num_gpusGPU) rfloatr0ray_rayletRESOURCE_UNIT_SCALING_private accelerators"get_all_accelerator_resource_names$get_accelerator_manager_for_resource"validate_resource_request_quantity)r%quantity resource_namevalid error_messagerrr_validate_resource_quantityGs,  rAcs ttttdffdd|dS)z*This is used for resource related options.Ncs|durdSt|SN)rAr*r,rrr-fsz"_resource_option..r/)rr4r0r)r%rrr,r_resource_optionbs   rC resourcesreturncCsN|durdSd|vsd|vr dS|D]\}}t||}|r$|SqdS)NCPUr3z[Use the 'num_cpus' and 'num_gpus' keyword instead of 'CPU' and 'GPU' in 'resources' keyword)itemsrA)rDr%r=rrrr_validate_resourcesks rHlabel_selectorcCt|SrBr r*rrrr-~r-accelerator_typememorynum_cpusr2object_store_memoryFplacement_groupdefaultr/placement_group_bundle_indexr(#placement_group_capture_child_taskscCrJrB)rHr*rrrr-rK runtime_envscheduling_strategy _metadataenable_task_events_labelsobjcls_cCs"zt||WStyYdSw)NF) issubclassr)rYrZrrrissubclass_safes   r\ max_calls max_retriescCs(|dus|dks|dks|dkrdSdS)Ndynamic streamingragDefault None. When None is passed, The default value is 1 for a task and actor task, and 'streaming' for generator tasks and generator actor tasks. The keyword 'num_returns' only accepts None, a non-negative integer, 'streaming' (for generators), or 'dynamic'. 'dynamic' flag will be deprecated in the future, and it is recommended to use 'streaming' instead.rr*rrrr-s cCs|durdSdS)Nz:Setting 'object_store_memory' is not implemented for tasksrr*rrrr-cCs2t|tst|ttfrtdd|DrdSdS)Ncss|]}t|tVqdSrB)r\ Exception).0x_rrr sz..zAretry_exceptions must be either a boolean or a list of exceptions)rboollisttupleallr*rrrr-s cCs|dkrdSdS)Nrz_generator_backpressure_num_objects=0 is not allowed. Use a value > 0. If the value is equal to 1, the behavior is identical to Python generator (generator 1 object whenever `next` is called). Use -1 to disable this feature. rr*rrrr-s)r]r^rN num_returnsrOretry_exceptions#_generator_backpressure_num_objectscCs|dvrdSdS)N)Ndetached non_detachedzOactor `lifetime` argument must be one of 'detached', 'non_detached' and 'None'.rr*rrrr-rbmax_concurrency max_restartsmax_task_retriesmax_pending_calls)concurrency_groupslifetimerprqrrrs namespace get_if_exists valid_options task_options actor_optionszThe @ray.remote decorator must be applied either with no arguments and no parentheses, for example '@ray.remote', or it must be applied using some of the arguments in the list zL, for example '@ray.remote(num_returns=2, resources={"CustomResource": 1})'.optionscCs6|dd}|d}|dvr|durtddSdS)z2Check if deprecated placement group option exists.rPrQrU)rQNNzrPlacement groups should be specified via the scheduling_strategy option. The placement_group option is deprecated.)getr)r{rPrUrrr _check_deprecate_placement_groups  r}caller_stacklevelcCs|d}|d}|d}|dkrtjdtdt|dd|d kr2tjd tdt|dd|rEtjd tdt|dddSdS) NrPrRrSrQzplacement_group parameter is deprecated. Use scheduling_strategy=PlacementGroupSchedulingStrategy(...) instead, see the usage at https://docs.ray.io/en/z&/ray-core/package-ref.html#ray-remote.r_ stacklevelr(zplacement_group_bundle_index parameter is deprecated. Use scheduling_strategy=PlacementGroupSchedulingStrategy(...) instead, see the usage at https://docs.ray.io/en/zplacement_group_capture_child_tasks parameter is deprecated. Use scheduling_strategy=PlacementGroupSchedulingStrategy(...) instead, see the usage at https://docs.ray.io/en/)warningswarnr DeprecationWarning)r{r~rPrRrSrrr)_warn_if_using_deprecated_placement_groups8 r in_optionscCsd|D]\}}|tvrtd|dttdt|||q|r,d|vr,tdt|dS)zOptions check for Ray tasks. Args: options: Options for Ray tasks. in_options: If True, we are checking the options under the context of ".options()". Invalid option keyword z& for remote functions. Valid ones are .r]z5Setting 'max_calls' is not supported in '.options()'.N)rGryrrhrr}r{rkvrrrvalidate_task_options7s  rcCs|D]\}}|tvrtd|dttdt|||q|r,d|vr,td|dr:|ds:tdd |vrKtjd td t d d t |dS)zOptions check for Ray actors. Args: options: Options for Ray actors. in_options: If True, we are checking the options under the context of ".options()". rz for actors. Valid ones are rrtz>Setting 'concurrency_groups' is not supported in '.options()'.rwr%z8The actor name must be specified to use `get_if_exists`.rOzSetting 'object_store_memory' for actors is deprecated since it doesn't actually reserve the required object store memory. Use object spilling that's enabled by default (https://docs.ray.io/en/zb/ray-core/objects/object-spilling.html) instead to bypass the object store memory size limitation.r_rN) rGrzrrhrr|rrr rr}rrrrvalidate_actor_optionsKs.  roriginal_options new_optionscCsni||}|ddur5|ddur5|d}|dD]\}}i||i|||<q ||d<|S)zUpdate original options with new options and return. The returned updated options contain shallow copy of original options. rVN)r|copyrG)rrupdated_optionsmetadatarvconfigrrrupdate_optionsqs  r)TNrB)5__doc__r dataclassesrtypingrrrrrrr5 ray._privater ray._private.label_utilsr ray._private.utilsr ray.util.placement_groupr ray.util.scheduling_strategiesrrrrr$rgr1rArCr4rHdictrr0_common_optionsr\DEFAULT_TASK_MAX_RETRIESrhri_task_only_options_actor_only_optionsrxr#ryrzkeysremote_args_error_stringr}rrrrrrrrs      "     !       8        #&