tract_core/
lib.rs

1#![allow(clippy::len_zero)]
2#![allow(clippy::missing_safety_doc)]
3#![allow(clippy::redundant_closure_call)]
4//! # Tract
5//!
6//! Tiny, no-nonsense, self contained, portable TensorFlow and ONNX inference.
7//!
8//! ## Example
9//!
10//! ```
11//! # extern crate tract_core;
12//! # fn main() {
13//! use tract_core::internal::*;
14//!
15//! // build a simple model that just add 3 to each input component
16//! let mut model = TypedModel::default();
17//!
18//! let input_fact = f32::fact(&[3]);
19//! let input = model.add_source("input", input_fact).unwrap();
20//! let three = model.add_const("three".to_string(), tensor1(&[3f32])).unwrap();
21//! let add = model.wire_node("add".to_string(),
22//!     tract_core::ops::math::add(),
23//!     [input, three].as_ref()
24//!     ).unwrap();
25//!
26//! model.auto_outputs().unwrap();
27//!
28//! // We build an execution plan. Default inputs and outputs are inferred from
29//! // the model graph.
30//! let plan = model.into_runnable().unwrap();
31//!
32//! // run the computation.
33//! let input = tensor1(&[1.0f32, 2.5, 5.0]);
34//! let mut outputs = plan.run(tvec![input.into()]).unwrap();
35//!
36//! // take the first and only output tensor
37//! let mut tensor = outputs.pop().unwrap();
38//!
39//! assert_eq!(tensor, tensor1(&[4.0f32, 5.5, 8.0]).into());
40//! # }
41//! ```
42//!
43//! While creating a model from Rust code is useful for testing the library,
44//! real-life use-cases will usually load a TensorFlow or ONNX model using
45//! tract-tensorflow or tract-onnx crates.
46//!
47
48extern crate bit_set;
49#[macro_use]
50extern crate derive_new;
51#[macro_use]
52pub extern crate downcast_rs;
53#[allow(unused_imports)]
54#[macro_use]
55extern crate log;
56#[allow(unused_imports)]
57#[macro_use]
58pub extern crate ndarray;
59#[cfg(test)]
60extern crate env_logger;
61pub extern crate num_traits;
62#[cfg(test)]
63extern crate proptest;
64
65pub extern crate tract_data;
66pub extern crate tract_linalg;
67
68pub use tract_data::declare_knob;
69pub use tract_data::knobs;
70
71#[macro_use]
72pub mod macros;
73#[macro_use]
74pub mod ops;
75
76pub mod axes;
77pub mod broadcast;
78pub mod floats;
79pub mod framework;
80pub mod lanes;
81pub mod model;
82pub mod optim;
83pub mod plan;
84#[macro_use]
85pub mod runtime;
86#[macro_use]
87pub mod transform;
88pub mod value;
89
90pub use dyn_clone;
91
92mod late_bind;
93
94/// This prelude is meant for code using tract.
95pub mod prelude {
96    pub use crate::framework::Framework;
97    pub use crate::model::*;
98    pub use crate::runtime::{RunOptions, Runnable, Runtime, State, runtime_for_name, runtimes};
99    pub use crate::value::{IntoTValue, TValue};
100    pub use std::sync::Arc;
101    pub use tract_data::prelude::*;
102
103    pub use ndarray as tract_ndarray;
104    pub use num_traits as tract_num_traits;
105    pub use tract_data;
106    pub use tract_linalg;
107    pub use tract_linalg::multithread;
108}
109
110/// This prelude is meant for code extending tract (like implementing new ops).
111pub mod internal {
112    pub extern crate inventory;
113    pub use crate::axes::{AxesMapping, Axis};
114    pub use crate::lanes::{LaneTable, LanedRunnable, SessionHandle};
115    pub use crate::late_bind::*;
116    pub use crate::ops::change_axes::*;
117    pub use crate::ops::element_wise::ElementWiseMiniOp;
118    pub use crate::ops::{Cost, EvalOp, Op, OpState, Validation};
119    pub use crate::plan::{
120        EvalContext, LaneId, Seating, SessionId, SimplePlan, SimpleState, TurnShared, TurnState,
121        TurnStateHandler,
122    };
123    pub use crate::prelude::*;
124    pub use crate::runtime::{
125        DefaultRuntime, Runnable, Runtime, State, runtime_for_name, runtimes,
126    };
127    pub use dims;
128    pub use downcast_rs as tract_downcast_rs;
129    pub use register_model_transform;
130    pub use register_runtime;
131    pub use register_simple_model_transform;
132    pub use std::borrow::Cow;
133    pub use std::collections::HashMap;
134    pub use std::hash::Hash;
135    pub use std::marker::PhantomData;
136    pub use tract_data::internal::*;
137    pub use tract_data::{
138        dispatch_copy, dispatch_datum, dispatch_datum_by_size, dispatch_floatlike, dispatch_numbers,
139    };
140    pub use tvec;
141    pub use {args_1, args_2, args_3, args_4, args_5, args_6, args_7, args_8};
142    pub use {as_op, not_a_typed_op, not_out_of_plan, op_as_typed_op, op_out_of_plan};
143    pub use {bin_to_super_type, element_wise, element_wise_oop};
144    pub use {rule_if, rule_if_let, rule_if_some};
145}
146
147#[cfg(test)]
148#[allow(dead_code)]
149fn setup_test_logger() {
150    let _ = env_logger::Builder::from_env("TRACT_LOG").try_init();
151}
tract_core/lib.rs

tract_core/
lib.rs
