Skip to content

Commit

Permalink
Clean up and rename.
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelburbulla committed Feb 6, 2024
1 parent 0d9bea5 commit b9d08fd
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 24 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/icon.png" width="100">
<img alt="Continuity" src="https://aai-institute.github.io/continuity/img/icon.png" width="100">

<h1>Continuity</h1>

Expand All @@ -9,11 +9,11 @@ Learning function operators with neural networks.
<a href="https://pytorch.org/get-started/locally/">
<img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-ee4c2c?logo=pytorch&logoColor=white">
</a>
<a href="https://aai-institute.github.io/Continuity/">
<a href="https://aai-institute.github.io/continuity/">
<img alt="Documentation" src="https://img.shields.io/badge/Documentation-blue">
</a>
<a href="https://github.com/aai-institute/Continuity/actions/workflows/test.yml">
<img alt="Test" src="https://github.com/aai-institute/Continuity/actions/workflows/test.yml/badge.svg">
<a href="https://github.com/aai-institute/continuity/actions/workflows/test.yml">
<img alt="Test" src="https://github.com/aai-institute/continuity/actions/workflows/test.yml/badge.svg">
</a>
</div>

Expand All @@ -25,20 +25,20 @@ examples and benchmarks.
## Installation
Clone the repository and install the package using pip.
```
git clone https://github.com/aai-institute/Continuity.git
cd Continuity
git clone https://github.com/aai-institute/continuity.git
cd continuity
pip install -e .
```

## Usage
Our [Documentation](https://aai-institute.github.io/Continuity/) contains a verbose introduction to operator learning, a collection of examples using Continuity, and a class documentation.
Our [Documentation](https://aai-institute.github.io/continuity/) contains a verbose introduction to operator learning, a collection of examples using Continuity, and a class documentation.

In general, the operator syntax in Continuity is
```python
v = operator(x, u(x), y)
```
mapping a function `u` (evaluated at `x`) to function `v` (evaluated in `y`).
For more details, see [Learning Operators](https://aai-institute.github.io/Continuity/operators/index.html).
For more details, see [Learning Operators](https://aai-institute.github.io/continuity/operators/index.html).

## Contributing
If you find a bug or have a feature request, please open an issue on GitHub. If
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ alias:

To install the latest development version use:
```
git clone https://github.com/aai-institute/Continuity.git
cd Continuity
git clone https://github.com/aai-institute/continuity.git
cd continuity
pip install -e .
```

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Home

<div align="center">

<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/icon.png" width="100">
<img alt="Continuity" src="https://aai-institute.github.io/continuity/img/icon.png" width="100">

<h1>Continuity</h1>

Expand Down
4 changes: 2 additions & 2 deletions docs/operators/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ $d$-dimensional input to $c$ output *channels*.

An **operator**
$$
G: u \to v
G: u \mapsto v
$$
maps $u$ to a function $v: Y \subset \mathbb{R}^{p} \to \mathbb{R}^{q}$.

Expand Down Expand Up @@ -56,7 +56,7 @@ points and write $\mathbf{x} = (x_i)_i$ and $\mathbf{u} = (u(x_i))_i$.
This finite dimensional representation is fed into the neural operator.

The mapped function $v = G(u)$, on the other hand, is also represented by
function evaluations only. Let $y_j \in Y,\ 1 \leq j \leq m,$ be a set of
function evaluations only. Let $y_j \in Y,\ 1 \leq j \leq m,$ be a finite set of
*evaluation points* (or *query points*) in the input domain $Y$ of $v$ and
$\mathbf{y} = (y_j)_j$.
Then, the output values $\mathbf{v} = (v(y_j))_j$ are approximated by the neural
Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
site_name: "Continuity"
site_dir: "docs_build"
site_url: "https://aai-institute.github.io/Continuity/"
repo_name: "aai-institute/Continuity"
repo_url: "https://github.com/aai-institute/Continuity"
site_url: "https://aai-institute.github.io/continuity/"
repo_name: "aai-institute/continuity"
repo_url: "https://github.com/aai-institute/continuity"
copyright: "Copyright &copy; appliedAI Institute for Europe gGmbH"
remote_branch: gh-pages

Expand Down Expand Up @@ -132,9 +132,9 @@ extra:
default: stable
social:
- icon: fontawesome/brands/github
link: https://github.com/aai-institute/Continuity
link: https://github.com/aai-institute/continuity
# - icon: fontawesome/brands/python
# link: https://pypi.org/project/Continuity/
# link: https://pypi.org/project/continuity/
- icon: fontawesome/brands/twitter
link: https://twitter.com/appliedAI_gGmbH
- icon: fontawesome/brands/linkedin
Expand Down
6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ license = GNU GPL v3.0
license_files = LICENSE.txt
long_description = file: README.md
long_description_content_type = text/markdown; charset=UTF-8; variant=GFM
url = https://github.com/aai-institute/Continuity.git
url = https://github.com/aai-institute/continuity.git
# Add here related links, for example:
project_urls =
Documentation = https://github.com/aai-institute/Continuity.git
Source = https://github.com/aai-institute/Continuity.git
Documentation = https://aai-institute.github.io/continuity/
Source = https://github.com/aai-institute/continuity.git

# Change if running only on Windows, Mac or Linux (comma-separated)
platforms = any
Expand Down
4 changes: 2 additions & 2 deletions src/continuity/data/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ def get_device() -> torch.device:
"""
device = torch.device("cpu")

# if torch.backends.mps.is_available():
# device = torch.device("mps")
if torch.backends.mps.is_available():
device = torch.device("mps")

if torch.cuda.is_available():
device = torch.device("cuda")
Expand Down
10 changes: 9 additions & 1 deletion src/continuity/operators/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@
```
"""

from .common import DeepResidualNetwork, NeuralNetworkKernel
from .operator import Operator
from .deeponet import DeepONet
from .neuraloperator import ContinuousConvolution, NeuralOperator

__all__ = ["Operator", "DeepONet", "ContinuousConvolution", "NeuralOperator"]
__all__ = [
"Operator",
"DeepONet",
"ContinuousConvolution",
"NeuralOperator",
"DeepResidualNetwork",
"NeuralNetworkKernel",
]

0 comments on commit b9d08fd

Please sign in to comment.