diff --git a/docs/examples/index.md b/docs/examples/index.md new file mode 100644 index 00000000..fafb6860 --- /dev/null +++ b/docs/examples/index.md @@ -0,0 +1,28 @@ +--- +title: Examples +--- + +This is a collection of notebooks that showcase various applications of +Continuity. + +::cards:: cols=2 + +- title: The Basics + content: Learning function operators with Continuity + url: basics + +- title: Physics-informed + content: > + Training physics-informed neural operators + url: physicsinformed + +- title: Self-supervised + content: > + Self-supervised training of operators + url: selfsupervised + +- title: Super-resolution + content: Neural operators for super-resolution + url: superresolution + +::/cards:: diff --git a/docs/index.md b/docs/index.md index f4221517..54ae0b1e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,11 +26,16 @@ examples and benchmarks. - title: Learning Operators content: > - Basics of learning function operators with neural networks + Basics of learning function operators url: operators/index.md +- title: Examples + content: > + Some notebooks using Continuity + url: examples/index.md + - title: Browse the API - content: Full documentation of the API + content: Full class documentation url: api/continuity/index.md ::/cards:: diff --git a/docs/operators/index.md b/docs/operators/index.md index 689fbe92..30be6036 100644 --- a/docs/operators/index.md +++ b/docs/operators/index.md @@ -86,4 +86,4 @@ Neural operators extend the concept of neural networks to function mappings, whi enables discretization-invariant and mesh-free mappings of data with applications to physics-informed training, super-resolution, and more. -See our examples (e.g., Basics) for more details and further reading. +See our Examples for more details and further reading. diff --git a/src/continuity/__init__.py b/src/continuity/__init__.py index 15a99624..00225032 100644 --- a/src/continuity/__init__.py +++ b/src/continuity/__init__.py @@ -1,6 +1,8 @@ """ **Continuity** is a Python package for machine learning on function operators. +The package is structured into the following modules: + ::cards:: cols=2 - title: Operators diff --git a/src/continuity/data/__init__.py b/src/continuity/data/__init__.py index c87cc2f8..df774674 100644 --- a/src/continuity/data/__init__.py +++ b/src/continuity/data/__init__.py @@ -1,6 +1,8 @@ """ -This defines DataSets in Continuity. -Every data set is a list of (x, u, y, v) tuples. +`continuity.data` + +Data sets in Continuity. +Every data set is a list of `(x, u, y, v)` tuples. """ import math diff --git a/src/continuity/operators/__init__.py b/src/continuity/operators/__init__.py index ca692b41..1b99723d 100644 --- a/src/continuity/operators/__init__.py +++ b/src/continuity/operators/__init__.py @@ -1,4 +1,15 @@ -"""Operators in Continuity.""" +""" +`continuity.operators` + +Operators in Continuity. + +Every operator maps collocation points `x`, function values `u`, +and evaluation points `y` to evaluations of `v`: + +``` +v = operator(x, u, y) +``` +""" from .operator import Operator from .deeponet import DeepONet diff --git a/src/continuity/pde/__init__.py b/src/continuity/pde/__init__.py index f0fa3ac6..00651ca0 100644 --- a/src/continuity/pde/__init__.py +++ b/src/continuity/pde/__init__.py @@ -1,4 +1,10 @@ -"""Loss functions for physics-informed training.""" +""" +`continuity.pde` + +PDEs in Continuity. + +Every PDE is implemented using a physics-informed loss function. +""" from torch import Tensor from abc import abstractmethod diff --git a/src/continuity/plotting/__init__.py b/src/continuity/plotting/__init__.py index b70533be..87bdb421 100644 --- a/src/continuity/plotting/__init__.py +++ b/src/continuity/plotting/__init__.py @@ -1,4 +1,8 @@ -"""Plotting utilities for Continuity.""" +""" +`continuity.plotting` + +Plotting utilities for Continuity. +""" import torch import numpy as np