Skip to content

Commit 86471f9

Browse files
committed
Update docs
1 parent c650a93 commit 86471f9

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/src/man/precompilation.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,31 @@ faster precompile times for fast TTFX for a wider range of inputs.
1717

1818
## Defaults
1919

20-
By default, precompilation is enabled for "tensors" of type `Array{T,N}`, where `T` and `N` range over the following values:
20+
By default, precompilation is disabled, but can be enabled for "tensors" of type `Array{T,N}`, where `T` and `N` range over the following values:
2121

2222
* `T` is either `Float64` or `ComplexF64`
2323
* `tensoradd!` is precompiled up to `N = 5`
2424
* `tensortrace!` is precompiled up to `4` free output indices and `2` pairs of traced indices
2525
* `tensorcontract!` is precompiled up to `3` free output indices on both inputs, and `2` contracted indices
2626

27-
## Custom settings
27+
To enable precompilation with these default settings, you can *locally* change the `"precompile_workload"` key in the preferences.
28+
29+
```julia
30+
using TensorOperations, Preferences
31+
set_preferences!(TensorOperations, "precompile_workload" => true; force=true)
32+
```
2833

29-
The default precompilation settings can be tweaked to allow for more or less expansive coverage. This is achieved
30-
through a combination of `PrecompileTools`- and `Preferences`-based functionality.
34+
## Custom settings
3135

32-
To disable precompilation altogether, for example during development or when you prefer to have small binaries,
33-
you can *locally* change the `"precompile_workload"` key in the preferences.
36+
The default precompilation settings can be tweaked to allow for more or less expansive coverage.
37+
This is achieved through a combination of `PrecompileTools`- and `Preferences`-based functionality.
3438

3539
```julia
3640
using TensorOperations, Preferences
37-
set_preferences!(TensorOperations, "precompile_workload" => false; force=true)
41+
set_preferences!(TensorOperations, "setting" => value; force=true)
3842
```
3943

40-
Alternatively, you can keep precompilation enabled, change the settings above through the same machinery, via:
44+
Here **setting** and **value** can take on the following:
4145

4246
* `"precomple_eltypes"`: a `Vector{String}` that evaluate to the desired values of `T<:Number`
4347
* `"precompile_add_ndims"`: an `Int` to specify the maximum `N` for `tensoradd!`

0 commit comments

Comments
 (0)