pub enum TreeExpansionPolicy {
Simple,
Weighted(WeightedNodeVariantPolicy),
WeightedWithLimits(WeightedNodeVariantPolicyWithLimits),
DepthBased(DepthBasedNodeVariantPolicy),
AlwaysAggregate,
AlwaysDispatch,
AlwaysLeafHolder,
Phased(PhasedNodeVariantPolicy),
Scripted(ScriptedNodeVariantPolicy),
}
Expand description
This structure is the primary enum for controlling how we choose among Dispatch
, Aggregate
, and
LeafHolder
nodes at each level of the tree generation procedure.
Each variant indicates a strategy for determining the mechanism of choosing the node-kind.
The choice should be made to optimally configure the grower for our target domain. Different domains will require different variant selections here.
It is important for the language model to determine intelligent behavior for its selection.
TODO: here we would like to indicate some useful guidelines about how to do this successfully.
Variants§
Simple
This strategy will always pick Dispatch
for intermediate nodes (levels < final) and LeafHolder
for
the final level. It will ignore aggregator nodes entirely. This is the classic “enum tree until depth,
then leaves at the bottom.”
Weighted(WeightedNodeVariantPolicy)
At each level, this strategy will randomly pick among aggregator/dispatch/leaf with the given weights. (It has no built-in depth constraints.)
WeightedWithLimits(WeightedNodeVariantPolicyWithLimits)
This strategy is the same as Weighted
, but with inline constraints like aggregator max depth, etc.
DepthBased(DepthBasedNodeVariantPolicy)
This strategy will define the level at which aggregator nodes “begin,” as well as the level at which leaf nodes “begin,” with dispatch nodes used before the aggregator nodes start.
Tuple Fields
0: DepthBasedNodeVariantPolicy
Here we need to take into account the characteristics of the target domain in order to choose specifically the levels at which nodes of a particular kind begin and when they *end.
AlwaysAggregate
This strategy will always pick aggregator except for the final level (which presumably is a leaf).
AlwaysDispatch
This strategy will always pick dispatch nodes except for during the final level.
AlwaysLeafHolder
This strategy will force every node to be a leaf, ignoring depth. Typically used for flattening or testing.
Phased(PhasedNodeVariantPolicy)
This strategy will specify a list of “phases,” each determining weights for aggregator/dispatch/leaf generation starting at a given depth, continuing until the next phase or the end.
Tuple Fields
0: PhasedNodeVariantPolicy
Here we need to take into account how many phases are useful for our target domain and what their parameters are.
Scripted(ScriptedNodeVariantPolicy)
This strategy uses a direct “per-level” approach via a map from u8
(level) → aggregator/dispatch/leaf
probabilities. If a level is missing, the downstream generator code will fallback or clamp to last known.
Tuple Fields
0: ScriptedNodeVariantPolicy
Here we need to take into account the target domain in order to choose relevant levels and their respective parameters
Trait Implementations§
Source§impl AiJsonTemplate for TreeExpansionPolicy
impl AiJsonTemplate for TreeExpansionPolicy
Source§fn to_template() -> Value
fn to_template() -> Value
Source§impl Clone for TreeExpansionPolicy
impl Clone for TreeExpansionPolicy
Source§fn clone(&self) -> TreeExpansionPolicy
fn clone(&self) -> TreeExpansionPolicy
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TreeExpansionPolicy
impl Debug for TreeExpansionPolicy
Source§impl Default for TreeExpansionPolicy
impl Default for TreeExpansionPolicy
Source§fn default() -> TreeExpansionPolicy
fn default() -> TreeExpansionPolicy
Source§impl<'de> Deserialize<'de> for TreeExpansionPolicy
impl<'de> Deserialize<'de> for TreeExpansionPolicy
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<TreeExpansionPolicy, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<TreeExpansionPolicy, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl From<JustifiedTreeExpansionPolicy> for TreeExpansionPolicy
impl From<JustifiedTreeExpansionPolicy> for TreeExpansionPolicy
Source§fn from(value: JustifiedTreeExpansionPolicy) -> TreeExpansionPolicy
fn from(value: JustifiedTreeExpansionPolicy) -> TreeExpansionPolicy
Source§impl LoadFromFile for TreeExpansionPolicywhere
TreeExpansionPolicy: for<'de> Deserialize<'de>,
impl LoadFromFile for TreeExpansionPolicywhere
TreeExpansionPolicy: for<'de> Deserialize<'de>,
type Error = SaveLoadError
fn load_from_file<'async_trait>(
filename: impl AsRef<Path> + Send + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<TreeExpansionPolicy, <TreeExpansionPolicy as LoadFromFile>::Error>> + Send + 'async_trait>>where
TreeExpansionPolicy: 'async_trait,
Source§impl PartialEq for TreeExpansionPolicy
impl PartialEq for TreeExpansionPolicy
Source§impl SaveToFile for TreeExpansionPolicywhere
TreeExpansionPolicy: Serialize,
impl SaveToFile for TreeExpansionPolicywhere
TreeExpansionPolicy: Serialize,
type Error = SaveLoadError
fn save_to_file<'life0, 'async_trait>(
&'life0 self,
filename: impl AsRef<Path> + Send + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<(), <TreeExpansionPolicy as SaveToFile>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
TreeExpansionPolicy: 'async_trait,
Source§impl Serialize for TreeExpansionPolicy
impl Serialize for TreeExpansionPolicy
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for TreeExpansionPolicy
Auto Trait Implementations§
impl Freeze for TreeExpansionPolicy
impl RefUnwindSafe for TreeExpansionPolicy
impl Send for TreeExpansionPolicy
impl Sync for TreeExpansionPolicy
impl Unpin for TreeExpansionPolicy
impl UnwindSafe for TreeExpansionPolicy
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
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> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
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 moreSource§impl<T> LoadFromDirectory for Twhere
T: LoadFromFile + Send,
<T as LoadFromFile>::Error: Display + From<SaveLoadError> + From<Error> + Send + 'static,
impl<T> LoadFromDirectory for Twhere
T: LoadFromFile + Send,
<T as LoadFromFile>::Error: Display + From<SaveLoadError> + From<Error> + Send + 'static,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);