Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
elftausend committed Feb 8, 2024
1 parent 8f53b2a commit 426868a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ min-cl = { git = "https://github.com/elftausend/min-cl", optional = true }
# min-cl = { version = "0.3.0", optional=true }

[features]
default = ["cuda", "graph", "lazy"]
default = ["cpu", "graph", "opencl", "autograd"]
# default = ["cpu", "lazy", "static-api", "graph", "autograd", "fork", "serde", "json"]

std = []
Expand Down
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ on by default | `Base` | Default behaviour.
autograd | `Autograd` | Enables running automatic differentiation.
cached | `Cached` | Reuses allocations on demand.
fork | `Fork` | Decides whether the CPU or GPU is faster for an operation. It then uses the faster device for following computations. (unified memory devices)
lazy | `Lazy` | Lazy execution of operations and intermediate allocations. Enables support for CUDA graphs.
lazy | `Lazy` | Lazy execution of operations and lazy intermediate allocations. Enables support for CUDA graphs.
graph | `Graph` | Adds a memory usage optimizeable graph.

Usage of these modules when writing custom operations: [`modules.md`](modules.md)
Expand All @@ -68,10 +68,6 @@ static-api | Enables the creation of `Buffer`s without providing a device.
macro | Reexport of [custos-macro]
blas | Adds gemm functions of the system's (selected) BLAS library.

<!-- Feature | Description -->
<!-- --- | --- -->
<!-- opt-cache | Makes the 'cache graph' optimizeable, lowering the memory footprint. -->

[custos-macro]: https://github.com/elftausend/custos-macro

## [Examples]
Expand All @@ -96,11 +92,11 @@ pub trait MulBuf<T, S: Shape = (), D: Device = Self>: Sized + Device {

impl<Mods, T, S, D> MulBuf<T, S, D> for CPU<Mods>
where
Mods: Retrieve<Self, T>,
Mods: Retrieve<Self, T, S>,
T: Mul<Output = T> + Copy + 'static,
S: Shape,
D: Device,
D::Data<T, S>: core::ops::Deref<Target = [T]>
D::Base<T, S>: core::ops::Deref<Target = [T]>
{
fn mul(&self, lhs: &Buffer<T, D, S>, rhs: &Buffer<T, D, S>) -> Buffer<T, Self, S> {
let mut out = self.retrieve(lhs.len(), (lhs, rhs));
Expand Down

0 comments on commit 426868a

Please sign in to comment.