Skip to content

Commit

Permalink
docs: update README with pipelined architecture diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
vijay-jaisankar committed Feb 9, 2023
1 parent 6dcf597 commit d3acee5
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# ssbd-plus
Code and material relevant to the paper, "Introducing SSBD+ Dataset with an Attentive Convolutional Pipeline for detecting Self-Stimulatory Behaviours in Children using raw videos"
# SSBD+
Code and material relevant to the paper, "Introducing SSBD+ Dataset with an Attentive Convolutional Pipeline for detecting Self-Stimulatory Behaviours in Children using raw videos"


![Pipelined Architecture](./docs/images/SSBDPipeline.png)

---
All relevant links can be found here:
### Installation and Usage: [INSTALL.md](./docs/INSTALL.md)
### Models and their description: [MODELS.md](./docs/MODELS.md)
18 changes: 17 additions & 1 deletion docs/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
## Using the models
## Installing the module

`pip install --upgrade ssbdplus`

### Note
You will need to have the following packages installed in your environment
- torch
- torchvision

---

## Instantiating the pipeline
```py
from ssbdplus.pipeline import SSBDPipeline

model = SSBDPipeline() # Instantiates the pipeline with default parameters
```

Binary file added docs/images/SSBDPipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d3acee5

Please sign in to comment.