Struct ControllerCommand

pub struct ControllerCommand {

    pub worker_world: String,
    pub system_addr: String,
    pub controller_actor_id: String,
    pub world_size: usize,
    pub num_procs_per_host: usize,
    pub worker_name: String,
    pub program: Option<String>,
    pub supervision_query_interval_in_sec: u64,
    pub supervision_update_interval_in_sec: u64,
    pub worker_progress_check_interval_in_sec: u64,
    pub operation_timeout_in_sec: u64,
    pub operations_per_worker_progress_request: u64,
    pub fail_on_worker_timeout: bool,
    pub is_cpu_worker: bool,
    pub extra_proc_labels: Option<Vec<(String, String)>>,
}

Fields

worker_world: String

The worker world to create

system_addr: String

The system address to bootstrap with.

controller_actor_id: String

The controller actor id to give to.

world_size: usize

num_procs_per_host: usize

The number of processes per host.

worker_name: String

The worker name.

program: Option<String>

The worker program to execute for each process. It is not needed if worker procs are directly launched without management from host actors.

supervision_query_interval_in_sec: u64

The supervision check interval in seconds. It indicates how often the controller will poll system actor to check the status of all procs/actors in a world. This decides how fast the client could observe a failure in the system.

supervision_update_interval_in_sec: u64

The supervision update interval in seconds, it indiciates how often the controller proc should report its supervision status to the system.

worker_progress_check_interval_in_sec: u64

The worker progress check interval in seconds, it indicates how often the controller will check that progress is being made.

operation_timeout_in_sec: u64

The operation timeout duration interval in seconds, it indicates how long we will allow progress to stall for before letting the client know that worker(s) may be stuck.

operations_per_worker_progress_request: u64

The number of operations invoked before we proactively check worker progress. If a large number of operations are invoked all at once, it is expected that it will take a while for all operations to complete so we want to inject progress requests at a higher frequency to check if we are making progress

fail_on_worker_timeout: bool

If the controller should propagate a failure to the client if the workers become stuck.

is_cpu_worker: bool

If to launch the workers for CPU-only devices.

extra_proc_labels: Option<Vec<(String, String)>>

Proc metadata which will be available through system.

Trait Implementations

impl Args for ControllerCommand

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for ControllerCommand

fn clone(&self) -> ControllerCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControllerCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ControllerCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for ControllerCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl IntoPy<Py<PyAny>> for ControllerCommand

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for ControllerCommand

type Target = ControllerCommand

The Python output type

type Output = Bound<'py, <ControllerCommand as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for ControllerCommand

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ControllerCommand

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ControllerCommand>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForControllerCommand

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<ControllerCommand> for PyClassImplCollector<ControllerCommand>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a ControllerCommand

type Holder = Option<PyRef<'py, ControllerCommand>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut ControllerCommand

type Holder = Option<PyRefMut<'py, ControllerCommand>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyTypeInfo for ControllerCommand

const NAME: &'static str = "ControllerCommand"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::type_object].

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl Serialize for ControllerCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for ControllerCommand