Docs.rs
  • auto-diff-0.5.9
    • auto-diff 0.5.9
    • Permalink
    • Docs.rs crate page
    • MIT
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • pipehappy1
    • Dependencies
      • auto-diff-macros ^0.5.9 normal
      • num-traits ^0.2 normal
      • rand ^0.8 normal
      • rand_distr ^0.4 normal
      • serde ^1.0 normal optional
      • tensor-rs ^0.5.9 normal
      • cargo-expand ^1 dev
      • criterion ^0.3 dev
      • csv ^1.1 dev
      • openblas-src ^0.10 dev
      • serde-pickle ^0.6 dev
      • tensorboard-rs ^0.5.9 dev
    • Versions
    • 18.98% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate auto_diff

auto_diff0.5.9

  • All Items

Sections

  • An auto-difference library
    • Introduction
    • Install
    • Features
    • Example

Crate Items

  • Re-exports
  • Modules
  • Macros

Crates

  • auto_diff

Crate auto_diff

Source
Expand description

§An auto-difference library

§Introduction

This is yet another auto-difference library for deep neural network. The focus is easy on use and dynamic computation graph building.

§Install

Add auto-diff = “0.5” to the [dependencies] section of your project Cargo.toml file.

§Features

The forward operators support a commonly used set, including:

  1. getter/setter,
  2. index and slicing,
  3. +, -, *, / and matmul,
  4. speciall functions,
  5. statistics,
  6. linear algebra,
  7. random number generator.

The corresponding gradient is work-in-progress.

One feature of auto-diff is the auto-difference is in background and don’t get in your way if only forward calculation is needed. Thus it can be used without syntax like variable place holder.

§Example

Re-exports§

pub use var::Var;
pub use err::AutoDiffError;

Modules§

collection
compute_graph
err
op
optim
Gradient based optimization.
serde
var
var_inner

Macros§

var_f64

Results

Settings
Help

Type "Nop" not found. Showing results for closest type name "op" instead.

    method
    auto_diff::collection::directed_graph::Graph::iter_input_given_op
    Return the list of input given the func.
    method
    auto_diff::collection::directed_graph::Graph::iter_output_given_op
    Return a list of data as the output of the op.
    struct
    auto_diff::op::Op
    Op is the Rc wrapper of typed op trait
    module
    auto_diff::op
    module
    auto_diff::serde::op
    method
    auto_diff::op::Op::clone
    &Op -> Op
    method
    auto_diff::op::Op::get_name
    &Op -> String
    method
    auto_diff::op::Op::ref_copy
    &Op -> Op
    method
    auto_diff::op::Op::get_input_size
    &Op -> usize
    method
    auto_diff::op::Op::get_output_size
    &Op -> usize
    method
    auto_diff::op::Op::get_grads
    &Op -> Vec<Tensor>
    return gradient for weight/parameters.
    method
    auto_diff::op::Op::get_values
    &Op -> Vec<Tensor>
    access weight/paramenters
    method
    auto_diff::compute_graph::Net::add_op
    &mut Net, Op -> GenKey
    Insert operator into the network.
    method
    auto_diff::op::Op::serialize
    &Op, S -> Result
    method
    auto_diff::op::Op::set_values
    &Op, &[Tensor] -> ()
    set parameters
    method
    auto_diff::op::Op::inner
    &Op -> &Rc<RefCell<Box<OpTrait>>>
    method
    auto_diff::op::Op::apply
    &Op, &[Tensor], &[Tensor] -> ()
    Read the input, do the calculation and write result to …
    method
    auto_diff::op::Op::grad
    &Op, &[Tensor], &[Tensor], &[Tensor] -> ()
    Given input and output_grad, return input_grad (forward …
    method
    auto_diff::op::Op::deserialize
    D -> Result<Op>
    method
    auto_diff::op::Op::new
    Rc<RefCell<Box<OpTrait>>> -> Op
    function
    auto_diff::op::deserialize_map
    String, V -> Result<Op>
    function
    auto_diff::op::deserialize_seq
    String, V -> Result<Op>
    method
    auto_diff::compute_graph::Net::get_op
    &Net, GenKey -> Result<Op, AutoDiffError>
    method
    auto_diff::op::Op::clone
    &Op -> Op
    method
    auto_diff::op::Op::ref_copy
    &Op -> Op