Skip to content

Commit

Permalink
Small typos
Browse files Browse the repository at this point in the history
  • Loading branch information
lkdvos committed Jul 15, 2024
1 parent 086d2d4 commit d9b2fa6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/src/man/backends.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ For convenience, the construction above is also provided in a specialized macro
@butensor
```

When using the `CuTENSORBackend()` and no allocator is specified, it will automatically select the
When using the `cuTENSORBackend()` and no allocator is specified, it will automatically select the
allocator `CUDAAllocator()`, which will create new temporaries as `CuArray` objects. However,
`CUDAAllocator` has three type parameters which can be used to customize the behavior of the allocator
with respect to temporaries, as well as input and output tensors.
Expand All @@ -165,4 +165,4 @@ TensorOperations.CUDAAllocator

Users can also define their own allocators, to facilitate experimentation with new implementations.
Here, no restriction is made on the type of the allocator, and any object can be passed as an allocator.
The required implementated methods are [`tensoralloc`](@ref) and [`tensorfree!`](@ref).
The required implemented methods are [`tensoralloc`](@ref) and [`tensorfree!`](@ref).
14 changes: 7 additions & 7 deletions docs/src/man/indexnotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ TensorOperations.IndexError
```

Once the expression is compiled, there can still be errors that will lead to runtime errors,
the type of which depends ont he specific type of tensor (e.g. `DimensionMismatch` for
the type of which depends on the specific type of tensor (e.g. `DimensionMismatch` for
`AbstractArray` objects). Indeed, indices with the same label, either open indices on the
two sides of the equation, or contracted indices, need to be compatible. For `AbstractArray`
objects, this means they must have the same size. Other tensor types might have more complicated
Expand All @@ -384,11 +384,11 @@ TensorOperations.dimcheck_tensorcontract
```

Whenever an incompatible index structures is detected at runtime, the resulting error will
originate deep within the implementation, at which point the error message will provide
little information as to which specific tensors and which indices are producing the mismatch.
When debugging, it might be useful to add the keyword argument `contractcheck = true` to
the `@tensor` macro. Explicit checks using `checkcontractible` are then enabled that are run
before any tensor operation is performed. When a mismatch is detected, these checks still
originate deep within the implementation, at which point the error message will provide
little information as to which specific tensors and which indices are producing the mismatch.
When debugging, it might be useful to add the keyword argument `contractcheck = true` to
the `@tensor` macro. Explicit checks using `checkcontractible` are then enabled that are run
before any tensor operation is performed. When a mismatch is detected, these checks still
have access to the label information and spawn a more informative error message.

A different type of check is the `costcheck` keyword argument, which can be given the values
Expand Down Expand Up @@ -454,4 +454,4 @@ operations.

```@docs
@cutensor
```
```

2 comments on commit d9b2fa6

@Jutho
Copy link
Owner

@Jutho Jutho commented on d9b2fa6 Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

  • Support for cuTENSOR v2 and with that, more recent version of CUDA.jl
  • Further improvement and extension of the backend and allocator support, with in particular, a package extension for allocating temporaries via Bumper.jl, and a new associated @butensor macro.
  • Improved AD support
  • Fallback implementations for AbstractArray objects which are not strided.
  • Breaking changes in the interface: argument order and argument type of the conjugation flags.
  • Restricted to Julia 1.8 and higher

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/111094

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v5.0.0 -m "<description of version>" d9b2fa6751b14cf5944761f6bd6a3374a62ceec6
git push origin v5.0.0

Please sign in to comment.