Skip to content

Commit eaca643

Browse files
authored
Revamp README with new content and structure (#769)
* README with badges and news section * add animation gif examples * generic improvement in README
1 parent 54a4d90 commit eaca643

File tree

4 files changed

+335
-173
lines changed

4 files changed

+335
-173
lines changed

API_scheme.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<h2>PINA Code Structure</h2>
2+
3+
4+
Here is a high-level overview of PINA’s main modules. For full details, refer to the
5+
<a href="https://mathlab.github.io/PINA/"><b>documentation</b></a>.
6+
7+
```mermaid
8+
flowchart TB
9+
PINA["<h1>pina</h1>The basic module including `Condition`, <tt>LabelTensor</tt>, `Graph` and `Trainer` API"]
10+
11+
subgraph R1[" "]
12+
direction LR
13+
PROB["<h2>pina.problem</h2> Module for defining problems via base class inheritance"]
14+
MODEL["<h2>pina.model</h2> Module for built-in PyTorch models full architectures"]
15+
SOLVER["<h2>pina.solver</h2> Module for built-in solvers and abstract interfaces"]
16+
CALLBACK["<h2>pina.callback</h2> Module for built-in callbacks to integrate training pipelines"]
17+
end
18+
19+
subgraph R2[" "]
20+
direction LR
21+
DOMAIN["<h2>pina.domain</h2> Module for defining geometries and set operations"]
22+
BLOCK["<h2>pina.block</h2> Module for built-in PyTorch models layers only"]
23+
OPTIM["<h2>pina.optim</h2> Module for build or import optimizers and schedulers"]
24+
DATA["<h2>pina.data</h2> Module for DataModules for data processing"]
25+
end
26+
27+
subgraph R3[" "]
28+
direction LR
29+
OPERATOR["<h2>pina.operator</h2> Module for differential operators"]
30+
ADAPT["<h2>pina.adaptive_function</h2> Module for PyTorch learnable activations"]
31+
LOSS["<h2>pina.loss</h2> Module for losses and weighting strategies"]
32+
CONDITION["<h2>pina.condition</h2> Module for model training constraints"]
33+
end
34+
35+
PINA --> PROB
36+
PINA --> MODEL
37+
PINA --> SOLVER
38+
PINA --> CALLBACK
39+
40+
PROB --> DOMAIN
41+
MODEL --> BLOCK
42+
SOLVER --> OPTIM
43+
CALLBACK --> DATA
44+
45+
DOMAIN --> OPERATOR
46+
BLOCK --> ADAPT
47+
OPTIM --> LOSS
48+
DATA --> CONDITION
49+
```

0 commit comments

Comments
 (0)