remove default values for height and fov

README.md

@@ -33,6 +33,12 @@ To get started with horizon-metrics, make sure you have the necessary dependenci
 
 This is how you can quickly evaluate your horizon prediction models using SEA-AI/horizon-metrics:
 
+> [!IMPORTANT]  
+> The vertical_fov_degrees and heigt parameters are required. The default value for roll_rehsold is 0.5 and for pitch_threshold it is 0.1.
+
+> [!IMPORTANT]  
+> The horizon metric should be calculated per sequence. Make sure that the vertical_fov and height are consistent across the inputs and do not change.
+
 ##### Use artifical data for testing
 
 ```python
@@ -78,7 +84,7 @@ prediction_points = [
 ```python
 import evaluate
 
-module = evaluate.load("SEA-AI/horizon-metrics", roll_threshold=0.5, pitch_threshold=0.1, vertical_fov_degrees=25.6, height=512)
+module = evaluate.load("SEA-AI/horizon-metrics", vertical_fov_degrees=25.6, height=512, roll_threshold=0.5, pitch_threshold=0.1)
 module.add(predictions=prediction_points, references=ground_truth_points)
 module.compute()
 

horizon-metrics.py

@@ -66,7 +66,7 @@ Examples:
                      [[0.0, 0.523573113510805], [1.0, 0.47642688648919496]]]
 
 
-    >>> module = evaluate.load("SEA-AI/horizon-metrics", roll_threshold=0.5, pitch_threshold=0.1, vertical_fov_degrees=25.6, height=512)
+    >>> module = evaluate.load("SEA-AI/horizon-metrics", vertical_fov_degrees=25.6, height=512, roll_threshold=0.5, pitch_threshold=0.1)
     >>> module.add(predictions=ground_truth_points, references=prediction_points)
     >>> module.compute()
     >>> {'average_slope_error': 0.014823194839790999,
@@ -87,9 +87,10 @@ class HorizonMetrics(evaluate.Metric):
     HorizonMetrics is a metric class that calculates horizon prediction metrics.
 
     Args:
+        vertical_fov_degrees (float): Vertical field of view in degrees.
+        height (int): Height of the image.
         roll_threshold (float, optional): Threshold for roll angle. Defaults to 0.5.
         pitch_threshold (float, optional): Threshold for pitch angle. Defaults to 0.1.
-        vertical_fov_degrees (float, optional): Vertical field of view in degrees. Defaults to 25.6.
         **kwargs: Additional keyword arguments.
 
     Attributes:
@@ -109,10 +110,10 @@ class HorizonMetrics(evaluate.Metric):
     """
 
     def __init__(self,
+                 vertical_fov_degrees,
+                 height,
                  roll_threshold=0.5,
                  pitch_threshold=0.1,
-                 vertical_fov_degrees=25.6,
-                 height=512,
                  **kwargs):
 
         super().__init__(**kwargs)