Update README.md

README.md

@@ -1,3 +1,42 @@
----
-license: gpl-3.0
----
+---
+license: gpl-3.0
+---
+
+
+# TrackingNet devkit
+
+```bash
+conda create -n TrackingNet python pip
+pip install TrackingNet
+```
+
+## Utility functions for TrackingNet
+
+```python
+from TrackingNet.utils import getListSplit
+
+# Get list of codenames for the 12 training + testing split
+TrackingNetSplits = getListSplit()
+print(getListSplit())
+# returns ["TEST", "TRAIN_0", "TRAIN_1", "TRAIN_2", "TRAIN_3", "TRAIN_4", "TRAIN_5", "TRAIN_6", "TRAIN_7", "TRAIN_8", "TRAIN_9", "TRAIN_10", "TRAIN_11"]
+
+
+# Get list of tracking sequences
+print(getListSequence(split=TrackingNetSplits[1])) # return list of tracking sequences in that split
+print(getListSequence(split="TEST")) # return list of tracking sequences for testing
+print(getListSequence(split=["TRAIN_0", "TRAIN_1"])) # return list of tracking sequences for train splits 0 and 1
+print(getListSequence(split="TRAIN")) # return list of tracking sequences for al train splits
+```
+
+## Downloading TrackingNet
+
+```python
+from TrackingNet.Downloader import TrackingNetDownloader
+from TrackingNet.utils import getListSplit
+
+
+downloader = TrackingNetDownloader(LocalDirectory="path/to/TrackingNet")
+
+for split in getListSplit():
+    downloader.downloadSplit(split)
+```