Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
drgona authored Nov 21, 2024
1 parent a033e87 commit 0cd637b
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ differentiable models and algorithms embedded with prior knowledge and physics.
1. [Overview](#overview)
2. [Key Features](#key-features)
3. [What's New in v1.5.2](#whats-new)
4. [Getting Started](#getting-started)
5. [Tutorials](#domain-examples)
5. [Installation](#installation)
4. [Installation](#installation)
5. [Getting Started](#getting-started)
6. [Tutorials](#domain-examples)
6. [Documentation and User Guides](#documentation-and-user-guides)


Expand Down Expand Up @@ -59,19 +59,25 @@ KANs to be trained in parallel to give accurate solutions for multiscale problem
> [Function Approximation with Kolgomorov-Arnold Networks ](#function-approximation)
## Getting Started


## Installation
Simply run
```
pip install neuromancer
```
For manual installation, please refer to [Installation Instructions](INSTALLATION.md)


## Getting Started

Extensive set of tutorials can be found in the
An extensive set of tutorials can be found in the
[examples](https://github.com/pnnl/neuromancer/tree/master/examples) folder and the [Tutorials](#domain-examples) below.
Interactive notebook versions of examples are available on Google Colab!
Test out NeuroMANCER functionality before cloning the repository and setting up an
environment.

The notebooks below introduce the core abstractions of the NeuroMANCER library, in particular our symbolic programming interface and Node classes.
The notebooks below introduce the core abstractions of the NeuroMANCER library, in particular, our symbolic programming interface and Node classes.

### Symbolic Variables, Nodes, Constraints, Objectives, and Systems Classes

Expand Down Expand Up @@ -263,13 +269,6 @@ We have integrated PyTorch Lightning to streamline code, enable custom training
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> Part 4: Defining Custom Training Logic via Lightning Modularized Code.


## Installation
Simply run
```
pip install neuromancer
```
For manual installation, please refer to [Installation Instructions](INSTALLATION.md)

## Documentation and User Guides
The documentation for the library can be found [online](https://pnnl.github.io/neuromancer/).
There is also an [introduction video](https://www.youtube.com/watch?v=YkFKz-DgC98) covering
Expand Down

0 comments on commit 0cd637b

Please sign in to comment.