opensportslib 0.1.3.dev1__tar.gz → 0.1.3.dev2__tar.gz

{opensportslib-0.1.3.dev1/opensportslib.egg-info → opensportslib-0.1.3.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensportslib
-Version: 0.1.3.dev1
+Version: 0.1.3.dev2
 Summary: OpenSportsLib is the professional library, designed for advanced video understanding in sports. It provides state-of-the-art tools for action recognition, spotting, retrieval, and captioning, making it ideal for researchers, analysts, and developers working with sports video data.
 Author: Jeet Vora
 Requires-Python: >=3.12
@@ -113,6 +113,9 @@ Use it as the main entry point to find:
 - extracted features
 - pretrained models and checkpoints
 
+See the [Model Zoo](docs/model-zoo.md) for available pretrained models,
+reported scores, datasets, and loading snippets.
+
 --
 
 ## Quickstart
@@ -131,7 +134,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 my_model.train(
@@ -147,7 +150,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(
@@ -178,7 +181,7 @@ from opensportslib.apis import LocalizationModel
 
 my_model = LocalizationModel(
     config="/path/to/localization.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/README.md

@@ -78,6 +78,9 @@ Use it as the main entry point to find:
 - extracted features
 - pretrained models and checkpoints
 
+See the [Model Zoo](docs/model-zoo.md) for available pretrained models,
+reported scores, datasets, and loading snippets.
+
 --
 
 ## Quickstart
@@ -96,7 +99,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 my_model.train(
@@ -112,7 +115,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(
@@ -143,7 +146,7 @@ from opensportslib.apis import LocalizationModel
 
 my_model = LocalizationModel(
     config="/path/to/localization.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/examples/quickstart/basic_classification.py

@@ -9,7 +9,7 @@ def main():
 
     my_model = ClassificationModel(
         config="examples/configs/classification_video.yaml",
-        weights="/path/to/weights.pt",  # optional
+        weights=None,  # optional: path or Hugging Face model ID
     )
 
     my_model.train(

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/examples/quickstart/basic_localization.py

@@ -9,7 +9,7 @@ def main():
 
     my_model = LocalizationModel(
         config="examples/configs/localization.yaml",
-        weights="/path/to/weights.pt",  # optional
+        weights=None,  # optional: path or Hugging Face model ID
     )
 
     my_model.train(

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2/opensportslib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensportslib
-Version: 0.1.3.dev1
+Version: 0.1.3.dev2
 Summary: OpenSportsLib is the professional library, designed for advanced video understanding in sports. It provides state-of-the-art tools for action recognition, spotting, retrieval, and captioning, making it ideal for researchers, analysts, and developers working with sports video data.
 Author: Jeet Vora
 Requires-Python: >=3.12
@@ -113,6 +113,9 @@ Use it as the main entry point to find:
 - extracted features
 - pretrained models and checkpoints
 
+See the [Model Zoo](docs/model-zoo.md) for available pretrained models,
+reported scores, datasets, and loading snippets.
+
 --
 
 ## Quickstart
@@ -131,7 +134,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 my_model.train(
@@ -147,7 +150,7 @@ from opensportslib.apis import ClassificationModel
 
 my_model = ClassificationModel(
     config="/path/to/classification.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(
@@ -178,7 +181,7 @@ from opensportslib.apis import LocalizationModel
 
 my_model = LocalizationModel(
     config="/path/to/localization.yaml",
-    weights="/path/to/weights.pt",  # optional
+    weights=None,  # optional: path or Hugging Face model ID
 )
 
 predictions = my_model.infer(

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "opensportslib"
-version = "0.1.3.dev1"
+version = "0.1.3.dev2"
 description = "OpenSportsLib is the professional library, designed for advanced video understanding in sports. It provides state-of-the-art tools for action recognition, spotting, retrieval, and captioning, making it ideal for researchers, analysts, and developers working with sports video data."
 readme = "README.md"
 requires-python = ">=3.12"

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/tools/training/classification.py

@@ -7,9 +7,9 @@ def parse_args():
     parser = argparse.ArgumentParser(description="Minimal classification training script.")
     parser.add_argument("--config", required=True, help="Path to the YAML config file.")
     parser.add_argument("--weights", default=None, help="Path to pretrained weights (optional).")
-    parser.add_argument("--train-set", required=True, help="Path to train annotations JSON.")
-    parser.add_argument("--valid-set", required=True, help="Path to validation annotations JSON.")
-    parser.add_argument("--test-set", required=True, help="Path to test annotations JSON.")
+    parser.add_argument("--train-set", default=None, help="Path to train annotations JSON. Defaults to DATA.train.path from the config.")
+    parser.add_argument("--valid-set", default=None, help="Path to validation annotations JSON. Defaults to DATA.valid.path from the config.")
+    parser.add_argument("--test-set", default=None, help="Path to test annotations JSON. Defaults to DATA.test.path from the config.")
     return parser.parse_args()
 
 

{opensportslib-0.1.3.dev1 → opensportslib-0.1.3.dev2}/tools/training/localization.py

@@ -7,9 +7,9 @@ def parse_args():
     parser = argparse.ArgumentParser(description="Minimal localization training script.")
     parser.add_argument("--config", required=True, help="Path to the YAML config file.")
     parser.add_argument("--weights", default=None, help="Path to pretrained weights (optional).")
-    parser.add_argument("--train-set", required=True, help="Path to train annotations JSON.")
-    parser.add_argument("--valid-set", required=True, help="Path to validation annotations JSON.")
-    parser.add_argument("--test-set", required=True, help="Path to test annotations JSON.")
+    parser.add_argument("--train-set", default=None, help="Path to train annotations JSON. Defaults to DATA.train.path from the config.")
+    parser.add_argument("--valid-set", default=None, help="Path to validation annotations JSON. Defaults to DATA.valid.path from the config.")
+    parser.add_argument("--test-set", default=None, help="Path to test annotations JSON. Defaults to DATA.test.path from the config.")
     return parser.parse_args()