Update README.md

README.md

@@ -62,35 +62,46 @@ import opensportslib
 print("OpenSportsLib imported successfully")
 ```
 
-### Train a classification model
+### Train a Localization model
 
 ```python
-from opensportslib import model
+from opensportslib.apis import LocalizationModel
 
-myModel = model.localization(
-    config="/path/to/localization.yaml"
+my_model = LocalizationModel(
+    config="/path/to/localization.yaml",
+👉  weights="OpenSportsLab/OSL-loc-snbas-2023-e2e",  # optional
 )
 
-myModel.train(
-    train_set="/path/to/train_annotations.json",
-    valid_set="/path/to/valid_annotations.json",
-👉  pretrained="OpenSportsLab/oslib-e2e-localization-snbas-2023",  # optional
+best_checkpoint = my_model.train(
+    train_set="/path/to/train.json",
+    valid_set="/path/to/valid.json",
 )
+
+print(best_checkpoint)
 ```
 
 ### Run inference
 
 ```python
-from opensportslib import model
+from opensportslib.apis import LocalizationModel
+
+my_model = LocalizationModel(
+    config="/path/to/localization.yaml",
+    weights="OpenSportsLab/OSL-loc-snbas-2023-e2e",
+)
+
+predictions = my_model.infer(
+    test_set="/path/to/test.json",
+)
 
-myModel = model.localization(
-    config="/path/to/localization.yaml"
+saved_predictions = my_model.save_predictions(
+    output_path="/path/to/predictions.json",
+    predictions=predictions,
 )
 
-metrics = myModel.infer(
-    test_set="/path/to/test_annotations.json",
-👉   pretrained="OpenSportsLab/oslib-e2e-localization-snbas-2023",
-    predictions="/path/to/predictions.json"
+metrics = my_model.evaluate(
+    test_set="/path/to/test.json",
+    predictions=saved_predictions,
 )
 
 print(metrics)