Upload folder using huggingface_hub

README.md

@@ -13,13 +13,28 @@ This model is a custom implementation of **ResNetYoloV1** from the ```vision_mod
 Please look in the config file for more information about the model architecture.
 
 ## **Usage**
-To load the model, you can use the following code snippet:
+To load the torch model, you can use the following code snippet:
 
 ```python
+import torch
 from vision_models_playground.utility.hub import load_vmp_model_from_hub
 
 
 model = load_vmp_model_from_hub("Akriel/ResNetYoloV1")
+
+x = torch.randn(...)
+y = model(x)  # y will be of type torch.Tensor
+```
+
+To load the pipeline that includes the model, you can use the following code snippet:
+
+```python
+from vision_models_playground.utility.hub import load_vmp_pipeline_from_hub
+
+pipeline = load_vmp_pipeline_from_hub("Akriel/ResNetYoloV1")
+
+x = raw_data  # raw_data will be of type pipeline.input_type
+y = pipeline(x)  # y will be of type pipeline.output_type
 ```
 
 ## **Metrics**