Skip to content

Commit

Permalink
Fix docs for using an IPU Model
Browse files Browse the repository at this point in the history
  • Loading branch information
giordano committed Apr 8, 2024
1 parent 1f59963 commit e0e2317
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/src/poplar.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ While this package requires a physical IPU to use all the available features, yo
The Poplar SDK provides a feature called IPU Model, which is a software emulation of the behaviour of the IPU hardware.
While the IPU model comes with [some limitations](https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/poplar_programs.html#programming-with-poplar), it can be useful for testing or debugging.
To use the IPU model in `IPUToolkit.jl`, define the device of your IPU program with `Poplar.IPUModelCreateDevice` (which calls [`IPUModel::createDevice`](https://docs.graphcore.ai/projects/poplar-api/en/3.4.0/poplar/profiling/IPUModel.html#_CPPv4NK6poplar8IPUModel12createDeviceE11OptionFlagsbj) under the hood):
To use the IPU model in `IPUToolkit.jl`, define the device of your IPU program with [`Poplar.get_ipu_model`](@ref):
```julia
device = Poplar.get_ipu_model()
# Then the rest of the program continues as usual
Expand Down

0 comments on commit e0e2317

Please sign in to comment.