diff --git a/README.md b/README.md index bb44e54..3ea7ae2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/MODELS.md b/docs/MODELS.md index 7421f6c..b4bbe23 100644 --- a/docs/MODELS.md +++ b/docs/MODELS.md @@ -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) \ No newline at end of file +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) \ No newline at end of file diff --git a/docs/images/SSBDPreFetchArch.png b/docs/images/SSBDPreFetchArch.png new file mode 100644 index 0000000..ebd1353 Binary files /dev/null and b/docs/images/SSBDPreFetchArch.png differ diff --git a/setup.cfg b/setup.cfg index 7fe4f5f..1a3a537 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = ssbdplus -version = 2.1.0 +version = 2.2.0 author = SARL, IIITB author_email = mr@iiitb.ac.in description = Models pertaining to the paper, Introducing SSBD+ Dataset with a Convolutional Pipeline for detecting Self-Stimulatory Behaviours in Children using raw videos