tiny tiny pretty things

README.md

@@ -1,6 +1,6 @@
 ---
-title: Labeling Template
-emoji: 🌍
+title: Pairwise Labeling Template
+emoji: 🏷️ 
 colorFrom: purple
 colorTo: gray
 sdk: gradio

app.py

@@ -20,7 +20,18 @@ HF_INPUT_DATASET_URL_COLUMN = os.getenv("HF_INPUT_DATASET_URL_COLUMN")
 HF_OUTPUT_DATASET = os.getenv("HF_OUTPUT_DATASET")
 HF_OUTPUT_DATASET_DIR = os.getenv("HF_OUTPUT_DATASET_DIR")
 INSTRUCTIONS = """
-# Pairwise Model Output Labeling
+# Pairwise Model Output Labeling Space
+
+### How-to:
+
+* Duplicate this Space
+* Add a `HF_TOKEN` secret in the Space settings (it saves the results to a given dataset, so it requires write access)
+* Set the environment variables in the [`.env`](https://huggingface.co/spaces/saridormi/labeling-template/blob/main/.env) file to point to correct datasets/columns/paths for your input and output data
+* Adjust `INSTRUCTIONS` (it's what's rendered here) and `SAVE_EVERY_N_EXAMPLES` (how often should answers be saved to the output dataset) in the [`app.py`](https://huggingface.co/spaces/saridormi/labeling-template/blob/main/app.py) file
+
+Done! 💛
+
+### About:
 
 Please compare the two model outputs shown below and select which one you think is better.
 - Choose "A is better" if the output from Model A (left) is superior
@@ -188,7 +199,6 @@ with gr.Blocks(css="footer {visibility: hidden}") as app:
     start_btn = gr.Button("Start Session", variant="primary", scale=1)
     
     # URL display component - only shown if URL column is defined
-    print(labeler.has_url_column)
     if labeler.has_url_column:
         url_display = gr.HTML(label="Reference URL", value="", visible=True)