You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/index.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,35 @@
2
2
CurrentModule = ModelingToolkitNeuralNets
3
3
```
4
4
5
-
# ModelingToolkitNeuralNets
5
+
# ModelingToolkitNeuralNets.jl
6
6
7
-
Documentation for [ModelingToolkitNeuralNets](https://github.com/SciML/ModelingToolkitNeuralNets.jl).
7
+
ModelingToolkitNeuralNets.jl is a package to create neural network components defined similar to MTKStandardLibrary components, to use them for solving Universal Differential Equations. It can be plugged to any part of the equations in an ODESystem using `RealInputArray` and `RealOutputArray` components which gives a lot of flexibility to add missing physics only to the relevant parts of the model.
8
8
9
-
```@index
10
-
```
9
+
## Installation
10
+
11
+
To install ModelingToolkitNeuralNets.jl, use the Julia package manager:
11
12
12
-
```@autodocs
13
-
Modules = [ModelingToolkitNeuralNets]
13
+
```julia
14
+
using Pkg
15
+
Pkg.add("ModelingToolkitNeuralNets")
14
16
```
15
17
18
+
## Contributing
19
+
20
+
- Please refer to the
21
+
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
22
+
for guidance on PRs, issues, and other matters relating to contributing to SciML.
23
+
24
+
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
25
+
- There are a few community forums:
26
+
27
+
+ The #diffeq-bridged and #sciml-bridged channels in the
28
+
[Julia Slack](https://julialang.org/slack/)
29
+
+ The #diffeq-bridged and #sciml-bridged channels in the
0 commit comments