Skip to content

Commit

Permalink
Restructure docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelburbulla committed Jun 20, 2024
1 parent 4ab4258 commit a614433
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 67 deletions.
2 changes: 1 addition & 1 deletion docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: How-to Guides
---

This is a collection of notebooks that showcase various applications of
Expand Down
22 changes: 0 additions & 22 deletions docs/getting-started/first-steps.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/getting-started/installation.md

This file was deleted.

24 changes: 11 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,20 @@ relevant benchmarks.

::cards:: cols=2

- title: Installation
content: Steps to install and requirements
url: getting-started/installation.md
- title: Tutorials
content: Getting started with continuiti
url: tutorials/index.md

- title: Learning Operators
content: >
Basics of learning function operators
url: operators/index.md

- title: Examples
content: >
Some notebooks using continuiti
- title: How-to Guides
content: Solve your problem
url: examples/index.md

- title: Browse the API
content: Full class documentation
- title: Background
content: Understanding operator learning
url: operators/index.md

- title: Reference
content: API documentation
url: api/continuiti/index.md

::/cards::
22 changes: 22 additions & 0 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Tutorials
---

# Tutorials

**continuiti** aims to implement recent advances in learning function operators,
i.e., mappings of (continuous) functions.

In the following, we will kindly introduce you step-by-step to the concepts of
operator learning. Let's start with installing **continuiti** and then move on
to the basics of operator learning with simple examples.

## Installing continuiti

Install the latest version of **continuiti** using pip:
```
pip install continuiti
```

**continuiti** requires Python>=3.9 and is built on top of
[PyTorch](https://pytorch.org/).
19 changes: 9 additions & 10 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -168,23 +168,22 @@ markdown_extensions:

nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- First Steps: getting-started/first-steps.md
- Learning Operators:
- Introduction: operators/index.md
- Tutorials:
- First Steps: tutorials/index.md
- Functions: examples/functions.ipynb
- Training: examples/training.ipynb
- Architectures: operators/architectures.md
- Examples:
- FNO: examples/fno.ipynb
- How-to Guides:
- Time Series: examples/timeseries.ipynb
- Super-resolution: examples/superresolution.ipynb
- Physics-informed: examples/physicsinformed.ipynb
- FNO: examples/fno.ipynb
- Meshes: examples/meshes.ipynb
- Self-supervised: examples/selfsupervised.ipynb
- Benchmarks: benchmarks/index.md
- Code:
- Background:
- Operator Learning: operators/index.md
- Architectures: operators/architectures.md
- Reference:
- API: api/continuiti/
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Benchmarks: benchmarks/index.md
9 changes: 7 additions & 2 deletions src/continuiti/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
content: Discretization utilities like samplers.
url: discrete/index.md
- title: Networks
content: Neural network implementations.
url: networks/index.md
- title: Operators
content: Neural operator implementations.
url: operators/index.md
Expand All @@ -41,19 +45,20 @@
"benchmarks",
"data",
"discrete",
"networks",
"operators",
"pde",
"trainer",
"transforms",
"Trainer",
]

from . import benchmarks
from . import data
from . import discrete
from . import networks
from . import operators
from . import pde
from . import trainer
from . import transforms

from .trainer import Trainer
from .trainer import Trainer # noqa

0 comments on commit a614433

Please sign in to comment.