Struct RogueNet

Source
pub struct RogueNet {
    pub config: RogueNetConfig,
    pub obs_space: ObsSpace,
    /* private fields */
}
Expand description

Implements the RogueNet entity neural network.

Fields§

§config: RogueNetConfig§obs_space: ObsSpace

Implementations§

Source§

impl RogueNet

Source

pub fn load<P: AsRef<Path>>(path: P) -> RogueNet

Loads the parameters for a trained RogueNet neural network from a checkpoint directory produced by enn-trainer.

§Arguments
  • path - Path to the checkpoint directory.
Source

pub fn load_archive<R: Read>(r: R) -> Result<RogueNet, Error>

Loads the parameters for a trained RogueNet neural network from a tar archive of a checkpoint directory.

§Arguments
  • r - A reader for the tar archive.
§Example
use std::fs::File;
use rogue_net::RogueNet;

let rogue_net = RogueNet::load_archive(File::open("test-data/simple.roguenet").unwrap());
Source

pub fn forward(&self, args: FwdArgs) -> (Array2<f32>, Vec<u64>)

Runs a forward pass of the RogueNet neural network.

§Arguments
  • entities - Maps each entity type to an Array2<f32> containing the entities’ features.
§Example
use std::collections::HashMap;
use ndarray::prelude::*;
use rogue_net::{RogueNet, FwdArgs};

let rogue_net = RogueNet::load("test-data/simple");
let mut features = HashMap::new();
features.insert("Head".to_string(), array![[3.0, 4.0]]);
features.insert("SnakeSegment".to_string(), array![[3.0, 4.0], [4.0, 4.0]]);
features.insert("Food".to_string(), array![[3.0, 5.0], [8.0, 4.0]]);
let (action_probs, actions) = rogue_net.forward(FwdArgs { features, ..Default::default() });
Source

pub fn with_obs_filter(self, obs_space: HashMap<String, Vec<String>>) -> Self

Adapts the RogueNet neural network to the given observation space by filtering out any features that were not present during training.

Trait Implementations§

Source§

impl Clone for RogueNet

Source§

fn clone(&self) -> RogueNet

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RogueNet

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V