Skip to main content

RustAI

Struct RustAI 

Source
pub struct RustAI { /* private fields */ }
Expand description

Unified facade for the rust-ai ecosystem.

Provides high-level APIs that orchestrate multiple ecosystem crates to accomplish common AI engineering tasks.

§Capabilities

WorkflowDescription
finetune()LoRA, DoRA, AdaLoRA adapter creation
quantize()4-bit (NF4/FP4) and 1.58-bit (BitNet) quantization
vsa()VSA-based operations and optimization
train()YAML-driven training pipelines

§Example

use rust_ai_core::{RustAI, RustAIConfig};

let config = RustAIConfig::new()
    .with_verbose(true);

let ai = RustAI::new(config).unwrap();
println!("Device: {:?}", ai.device());
println!("Ecosystem: {:?}", ai.ecosystem());

Implementations§

Source§

impl RustAI

Source

pub fn new(config: RustAIConfig) -> Result<Self>

Create a new RustAI instance.

Initializes the device and ecosystem information.

§Arguments
  • config - Configuration options
§Returns

A configured RustAI instance.

§Errors

Returns CoreError::DeviceNotAvailable if device initialization fails.

§Example
use rust_ai_core::{RustAI, RustAIConfig};

let ai = RustAI::new(RustAIConfig::default())?;
Source

pub fn device(&self) -> &Device

Get the active device.

Source

pub fn ecosystem(&self) -> &EcosystemInfo

Get ecosystem information.

Source

pub fn config(&self) -> &RustAIConfig

Get the configuration.

Source

pub fn is_cuda(&self) -> bool

Check if CUDA is available and active.

Source

pub fn finetune(&self) -> FinetuneBuilder<'_>

Start a fine-tuning workflow.

Returns a builder for configuring and running fine-tuning.

§Example
let config = ai.finetune()
    .model("meta-llama/Llama-2-7b")
    .adapter(AdapterType::Lora)
    .rank(64)
    .build()?;
Source

pub fn quantize(&self) -> QuantizeBuilder<'_>

Start a quantization workflow.

Returns a builder for configuring and running quantization.

§Example
let config = ai.quantize()
    .method(QuantizeMethod::Nf4)
    .bits(4)
    .build();
Source

pub fn vsa(&self) -> VsaBuilder<'_>

Start a VSA workflow.

Returns a builder for VSA-based operations.

§Example
let config = ai.vsa()
    .dimension(10000)
    .build();
Source

pub fn train(&self) -> TrainBuilder<'_>

Start an Axolotl training pipeline.

Returns a builder for YAML-driven training configuration.

§Example
let config = ai.train()
    .config_file("config.yaml")
    .build()?;
Source

pub fn info(&self) -> RustAIInfo

Get information about the RustAI environment.

Returns a struct containing version info, ecosystem, and device details.

Auto Trait Implementations§

§

impl Freeze for RustAI

§

impl RefUnwindSafe for RustAI

§

impl Send for RustAI

§

impl Sync for RustAI

§

impl Unpin for RustAI

§

impl UnwindSafe for RustAI

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Ungil for T
where T: Send,