Skip to content

Commit 5b2e08c

Browse files
author
Sathvik Bhagavan
committed
docs: update index.md
1 parent 6234672 commit 5b2e08c

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

docs/src/index.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,35 @@
22
CurrentModule = ModelingToolkitNeuralNets
33
```
44

5-
# ModelingToolkitNeuralNets
5+
# ModelingToolkitNeuralNets.jl
66

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.
88

9-
```@index
10-
```
9+
## Installation
10+
11+
To install ModelingToolkitNeuralNets.jl, use the Julia package manager:
1112

12-
```@autodocs
13-
Modules = [ModelingToolkitNeuralNets]
13+
```julia
14+
using Pkg
15+
Pkg.add("ModelingToolkitNeuralNets")
1416
```
1517

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
30+
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
31+
+ On the [Julia Discourse forums](https://discourse.julialang.org)
32+
+ See also [SciML Community page](https://sciml.ai/community/)
33+
1634
## Reproducibility
1735

1836
```@raw html

0 commit comments

Comments
 (0)