Struct Space 

pub struct Space { /* private fields */ }

The knobs, in the order they were declared.

use somatize_study::{Dimension, Space};

let space = Space::new()
    .with("lr", Dimension::Real { low: 1e-5, high: 1e-1, log: true })?
    .with("batch", Dimension::Int { low: 16, high: 128 })?
    .with("optimizer", Dimension::Choice(vec!["adam".into(), "sgd".into()]))?;
assert_eq!(space.len(), 3);

Implementations

impl Space

pub fn new() -> Self

Nothing to search yet.

pub fn with( self, name: impl Into<String>, dimension: Dimension, ) -> Result<Self, SpaceError>

One more knob. The name has to be new, and what it may be has to be something: an empty Choice or a range the wrong way round is refused here, where it was written, and not as a search that quietly only ever tried one value.

pub fn read(&self, said: &str) -> Result<Point, ReadError>

The point that text names, read against these knobs.

The other half of Point’s Display, and it needs the space: batch=64 on its own does not say whether 64 is a whole number or a Choice spelt "64". This is what makes a study’s history come back in one scan and no fetches.

Every knob has to be there and nothing else may be: a record written against another space is a different study.

use somatize_study::{Dimension, Space};

let space = Space::new()
    .with("lr", Dimension::Real { low: 1e-5, high: 1e-1, log: true })?
    .with("opt", Dimension::Choice(vec!["adam".into(), "sgd".into()]))?;
let point = space.read("lr=0.001,opt=adam")?;

assert_eq!(point.to_string(), "lr=0.001,opt=adam");

pub fn dimensions(&self) -> &[(String, Dimension)]

The knobs, in declaration order.

pub fn len(&self) -> usize

How many knobs there are.

pub fn is_empty(&self) -> bool

Whether there is nothing to search.

Trait Implementations

impl Clone for Space

fn clone(&self) -> Space

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Space

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

Formats the value using the given formatter.

impl Default for Space

fn default() -> Space

Returns the “default value” for a type.

impl Display for Space

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

Formats the value using the given formatter.

impl PartialEq for Space

fn eq(&self, other: &Space) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Space