pub struct SchemaField {Show 19 fields
pub name: Option<String>,
pub label: Option<String>,
pub description: Option<String>,
pub required: bool,
pub default: Option<Parameter>,
pub field_type: Option<SchemaFieldType>,
pub min: Option<f64>,
pub max: Option<f64>,
pub step: Option<f64>,
pub options: Vec<SchemaOption>,
pub children: Vec<SchemaField>,
pub is_dropdown: bool,
pub multi_select: bool,
pub is_multi_line: bool,
pub hidden: bool,
pub numeric_only: bool,
pub enable_tags_selection: bool,
pub enable_annotation_set_selection: bool,
pub values: Option<Vec<Parameter>>,
}Expand description
A single field descriptor from a trainer or validator parameter schema.
Schemas describe the hyperparameters a trainer/validator accepts —
the same descriptors the Studio UI renders as dynamic forms. Use them
to discover parameter names, defaults, and valid ranges before
launching a session with Client::start_training_session.
Deserialization is tolerant: unknown JSON keys are ignored and most fields are optional, so schema evolution on the server does not break this client.
Fields§
§name: Option<String>Parameter name — the key to use in the launch params map.
label: Option<String>Human-readable label; non-string labels are coerced to strings.
description: Option<String>Longer description of the parameter.
required: boolWhether a value is required to launch.
default: Option<Parameter>Default value applied when the parameter is omitted.
field_type: Option<SchemaFieldType>The kind of input this field describes.
min: Option<f64>Minimum value (numeric fields).
max: Option<f64>Maximum value (numeric fields).
step: Option<f64>Step size (numeric fields).
options: Vec<SchemaOption>Selectable options (select fields).
children: Vec<SchemaField>Nested fields (group fields, or bool fields that reveal
sub-parameters when enabled).
is_dropdown: boolRender the select as a dropdown.
multi_select: boolAllow selecting multiple options.
is_multi_line: boolRender the text input as multi-line.
Mask the text input (passwords).
numeric_only: boolRestrict text input to numeric characters.
Dataset fields: enable dataset tag selection.
enable_annotation_set_selection: boolDataset fields: enable annotation set selection.
values: Option<Vec<Parameter>>Slider fields: number of slider handles (1 = value, 2 = range).
Trait Implementations§
Source§impl Clone for SchemaField
impl Clone for SchemaField
Source§fn clone(&self) -> SchemaField
fn clone(&self) -> SchemaField
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SchemaField
impl Debug for SchemaField
Source§impl<'de> Deserialize<'de> for SchemaField
impl<'de> Deserialize<'de> for SchemaField
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for SchemaField
impl RefUnwindSafe for SchemaField
impl Send for SchemaField
impl Sync for SchemaField
impl Unpin for SchemaField
impl UnsafeUnpin for SchemaField
impl UnwindSafe for SchemaField
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more