docs: pre-release documentation

sarl-iiitb · Feb 9, 2023 · 5b81dc3 · 5b81dc3
1 parent d3acee5
commit 5b81dc3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,15 @@ Code and material relevant to the paper, "Introducing SSBD+ Dataset with an Atte
 
 ![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) 
+###  Models and their description: [MODELS.md](./docs/MODELS.md) 
+
+```py
+from ssbdplus.pipeline import SSBDPipeline
+
+model = SSBDPipeline()
+```
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = ssbdplus
-version = 0.0.2
+version = 1.0.0
 author = SARL, IIITB
 author_email = [email protected]
 description = Models pertaining to the paper, Introducing SSBD+ Dataset with an Attentive Convolutional Pipeline for detecting Self-Stimulatory Behaviours in Children using raw videos