diff --git a/README.md b/README.md index 49d0ea4b..774df03b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-Continuity +Continuity

Continuity

@@ -9,11 +9,11 @@ Learning function operators with neural networks. PyTorch - + Documentation - - Test + + Test
@@ -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 diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index d16823f1..438dbf63 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -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 . ``` diff --git a/docs/index.md b/docs/index.md index 54ae0b1e..86a7ebec 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ title: Home
-Continuity +Continuity

Continuity

diff --git a/docs/operators/index.md b/docs/operators/index.md index 30be6036..80a14f9c 100644 --- a/docs/operators/index.md +++ b/docs/operators/index.md @@ -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}$. @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 8e4d3037..7fd028fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 © appliedAI Institute for Europe gGmbH" remote_branch: gh-pages @@ -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 diff --git a/setup.cfg b/setup.cfg index ff11f2e3..fcd79604 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 diff --git a/src/continuity/data/__init__.py b/src/continuity/data/__init__.py index df774674..cc6e170f 100644 --- a/src/continuity/data/__init__.py +++ b/src/continuity/data/__init__.py @@ -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") diff --git a/src/continuity/operators/__init__.py b/src/continuity/operators/__init__.py index 1b99723d..78dedef0 100644 --- a/src/continuity/operators/__init__.py +++ b/src/continuity/operators/__init__.py @@ -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", +]