Skip to content

Commit 4f501a5

Browse files
committed
Update README
1 parent 935a6db commit 4f501a5

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TensorOperationsTBLIS.jl
22

3-
Julia wrapper for [tblis](https://github.com/devinamatthews/tblis) with [TensorOperations.jl](https://github.com/Jutho/TensorOperations.jl).
3+
Julia wrapper for [TBLIS](https://github.com/devinamatthews/tblis) with [TensorOperations.jl](https://github.com/Jutho/TensorOperations.jl).
44

55
[![CI][ci-img]][ci-url] [![CI (Julia nightly)][ci-julia-nightly-img]][ci-julia-nightly-url] [![][codecov-img]][codecov-url]
66

@@ -13,15 +13,14 @@ Julia wrapper for [tblis](https://github.com/devinamatthews/tblis) with [TensorO
1313
[codecov-img]: https://codecov.io/gh/lkdvos/TensorOperationsTBLIS.jl/graph/badge.svg?token=R86L0S70VT
1414
[codecov-url]: https://codecov.io/gh/lkdvos/TensorOperationsTBLIS.jl
1515

16-
Currently provides implementations of `tensorcontract!`, `tensoradd!` and `tensortrace!` for
17-
`StridedArray{<:BlasFloat}`. These can be accessed through the backend system of
18-
TensorOperations, i.e.
16+
Currently provides implementations of `tensorcontract!`, `tensoradd!` and `tensortrace!` for array types compatible with Strided.jl, i.e. `StridedView{<:BlasFloat}`.
17+
These can be accessed through the backend system of TensorOperations, i.e.
1918

2019
```julia
2120
using TensorOperations
2221
using TensorOperationsTBLIS
2322

24-
tblisbackend = tblisBackend()
23+
tblisbackend = TBLIS()
2524
α = randn()
2625
A = randn(5, 5, 5, 5, 5, 5)
2726
B = randn(5, 5, 5)
@@ -34,17 +33,16 @@ D = zeros(5, 5, 5)
3433
end
3534
```
3635

37-
Additionally, the number of threads used by tblis can be set by:
36+
Additionally, the number of threads used by TBLIS can be set by:
3837

3938
```julia
40-
using TensorOperationsTBLIS
41-
tblis_set_num_threads(4)
42-
@show tblis_get_num_threads()
39+
TensorOperationsTBLIS.set_num_threads(4)
40+
@show TensorOperationsTBLIS.get_num_threads()
4341
```
4442

4543
## Notes
4644

47-
- This implementation of tblis for TensorOperations.jl is only supported from v5 of
45+
- This implementation of TBLIS for TensorOperations.jl is only supported from v5 of
4846
TensorOperations.jl onwards. For v4, an earlier version of this package exists.
4947
For older versions, you could look for
5048
[BliContractor.jl](https://github.com/xrq-phys/BliContractor.jl) or

0 commit comments

Comments
 (0)