-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README with pipelined architecture diagram
- Loading branch information
1 parent
6dcf597
commit d3acee5
Showing
3 changed files
with
27 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.