Tullio.jl icon indicating copy to clipboard operation
Tullio.jl copied to clipboard

Adding a "Quick Start" section to the README, with a list of recommended packages to install?

Open DilumAluthge opened this issue 3 years ago • 0 comments

Could we add a "Quick Start" section to the README, to help beginners that want to quickly get started playing around with Tullio? The section would include a list of recommended packages for use with Tullio.

E.g. maybe something like this?

Quick Start

julia> using Pkg

julia> Pkg.add(["Tullio", "LoopVectorization", "TensorOperations", "KernelAbstractions"])

julia> using Tullio, LoopVectorization, TensorOperations, KernelAbstractions

julia> matmul(A, B) = @tullio C[i,k] := A[i,j] * B[j,k]

julia> X = [1.0 2.0 3.0; 4.0 5.0 6.0]

julia> Y = [7.0 8.0; 9.0 10.0; 11.0 12.0]

julia> matmul(X, Y)

Are these the right packages for someone to start off with?

  • Tullio
  • LoopVectorization
  • TensorOperations
  • KernelAbstractions

DilumAluthge avatar Dec 14 '20 07:12 DilumAluthge