Skip to content

Commit

Permalink
docs: add prefetch model description
Browse files Browse the repository at this point in the history
  • Loading branch information
vijay-jaisankar committed Jun 17, 2023
1 parent afe4228 commit 06e2fe9
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All relevant links can be found here:

`pip install --upgrade ssbdplus`

### Models and their description: [MODELS.md](./docs/MODELS.md)
### Models and their descriptions: [MODELS.md](./docs/MODELS.md)

```py
from ssbdplus.pipeline import SSBDPipeline
Expand Down
11 changes: 8 additions & 3 deletions docs/MODELS.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
## SSBDPLUS - Models

### M1 - Preprocessing: Prefetch
![Prefetch image](./images/SSBDPreFetchArch.png)

Code and documentation for this model can be found [here](../src/ssbdplus/prefetch.py)

### M1 - Action presence detection
![M1 image](./images/SSBDM1.png)

Code and documentation for this model can be found [here](../src/m1.py)
Code and documentation for this model can be found [here](../src/ssbdplus/m1.py)

### M2 - Action type classification
![M2 image](./images/SSBDM2.png)

Code and documentation for this model can be found [here](../src/m2.py)
Code and documentation for this model can be found [here](../src/ssbdplus/m2.py)

## Running the pipeline

To use the model used in the paper for your task, you can initialise an object defined in the [pipeline file](../src/pipeline.py)
To use the model used in the paper for your task, you can initialise an object defined in the [pipeline file](../src/ssbdplus/pipeline.py)
Binary file added docs/images/SSBDPreFetchArch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = ssbdplus
version = 2.1.0
version = 2.2.0
author = SARL, IIITB
author_email = [email protected]
description = Models pertaining to the paper, Introducing SSBD+ Dataset with a Convolutional Pipeline for detecting Self-Stimulatory Behaviours in Children using raw videos
Expand Down

0 comments on commit 06e2fe9

Please sign in to comment.