User Guide

NeuralOperator provides all the tools you need to easily use, build and train neural operators for your own applications and learn mapping between function spaces, in PyTorch.

NeuralOperator library structure

Here are the main components of the library:

Module	Description
`neuralop`	Main library
`neuralop.models`	Full ready-to-use neural operators
`neuralop.layers`	Individual layers to build neural operators
`neuralop.data`	Convenience PyTorch data loaders for PDE datasets
`neuralop.training`	Utilities to train neural operators end-to-end

The full API documentation is provided in the API reference.

Finally, if you’re building the library from source, your repository will also include the following directories:

Directory	Description
`scripts`	Training recipe scripts for our models on sample problems
`examples`	More documented interactive examples, seen in Examples

Interactive examples with code

We also provide interactive examples that show our library and neural operator models in action. To get up to speed on the code, and look through some interactive examples to help you hit the ground running, check out our Examples.