surrealml-core 0.1.12

The core machine learning library for SurrealML that enables SurrealDB to store and load ML models
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! Defines the placeholder for the type of model engine in the header.
use std::fmt;

/// Defines the type of engine being used to run the model.
///
/// # Fields
/// * `Native` - The native engine which will be native rust and linfa.
/// * `PyTorch` - The PyTorch engine which will be PyTorch and tch-rs.
/// * `Undefined` - The undefined engine which will be used when the engine is not defined.
#[derive(Debug, PartialEq)]
pub enum Engine {
	Native,
	PyTorch,
	Undefined,
}

impl Engine {
	/// Creates a new `Engine` struct with the undefined engine.
	///
	/// # Returns
	/// A new `Engine` struct with the undefined engine.
	pub fn fresh() -> Self {
		Engine::Undefined
	}

	/// Creates a new `Engine` struct from a string.
	///
	/// # Arguments
	/// * `engine` - The engine as a string.
	///
	/// # Returns
	/// A new `Engine` struct.
	pub fn from_string(engine: String) -> Self {
		match engine.as_str() {
			"native" => Engine::Native,
			"pytorch" => Engine::PyTorch,
			_ => Engine::Undefined,
		}
	}
}

impl fmt::Display for Engine {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		match self {
			Engine::Native => write!(f, "native"),
			Engine::PyTorch => write!(f, "pytorch"),
			Engine::Undefined => write!(f, ""),
		}
	}
}