docs

README.md

@@ -1,3 +1,20 @@
+---
+title: SignWriting Similarity
+sdk: gradio
+sdk_version: 5.29.0
+app_file: app.py
+pinned: false
+tags:
+- evaluate
+- metric
+description: >-
+  The Symbol Distance Metric is a novel evaluation metric specifically designed for SignWriting, 
+  a visual writing system for signed languages. Unlike traditional string-based metrics (e.g., BLEU, chrF), 
+  this metric directly considers the visual and spatial properties of individual symbols used in SignWriting, 
+  such as base shape, orientation, rotation, and position. It is primarily used to evaluate model outputs in 
+  SignWriting transcription and translation tasks, offering a similarity score between a predicted and a reference sign.
+---
+
 # Metric Card for SignWriting Similarity
 
 ## Metric Description
@@ -10,9 +27,6 @@ The metric is used by passing two SignWriting signs (as sets of symbols) and com
 
 * **hypothesis** *(List\[Symbol]):* The output sign, represented as a list of symbols with visual and spatial properties.
 * **reference** *(List\[Symbol]):* The gold/reference sign, in the same format.
-* **alpha** *(float, default=2.0):* Controls exponential scaling of symbol distance normalization.
-* **beta** *(float, default=2.0):* Controls the penalty for sign length mismatches.
-* **gamma** *(float, default=1.0):* Controls final exponential scaling of the overall score.
 
 ### Output Values