Mention predecessors in README

lkdvos · Jul 21, 2023 · 96c4261 · 96c4261 · lkdvos · Jul 21, 2023
1 parent 993ffd0
commit 96c4261
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -13,7 +13,7 @@ tblis_jll = "9c7f617c-f299-5d18-afb6-044c7798b3d0"
 [compat]
 TensorOperations = "4"
 TupleTools = "1"
-julia = "1.6 - 1"
+julia = "1.6"
 tblis_jll = "1.2"
 
 [extras]

diff --git a/README.md b/README.md
@@ -13,7 +13,10 @@
 [codecov-img]: https://codecov.io/gh/lkdvos/TensorOperationsTBLIS.jl/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/lkdvos/TensorOperationsTBLIS.jl
 
-Currently provides implementations of `tensorcontract!` and `tensoradd!` for `StridedArray{<:BlasFloat}`. These can be accessed through the backend system of TensorOperations, i.e.
+Currently provides implementations of `tensorcontract!` and `tensoradd!` for
+`StridedArray{<:BlasFloat}`. These can be accessed through the backend system of
+TensorOperations, i.e.
+
 ```julia
 using TensorOperations
 using TensorOperationsTBLIS
@@ -31,8 +34,16 @@ end
 ```
 
 Additionally, the number of threads used by tblis can be set by:
+
 ```julia
 using TensorOperationsTBLIS
 tblis_set_num_threads(4)
 @show tblis_get_num_threads()
 ```
+
+## Notes
+
+- This implementation of tblis for TensorOperations.jl is only supported from v4.0.0 of
+  TensorOperations.jl onwards. For older versions, you could look for
+  [BliContractor.jl](https://github.com/xrq-phys/BliContractor.jl) or
+  [TBLIS.jl](https://github.com/FermiQC/TBLIS.jl).