Add citations

yourbench_space/app.py

@@ -1,8 +1,9 @@
 import os
 import sys
-import time  # Needed for file existence check
+import time
 import gradio as gr
 import yaml
+from pathlib import Path
 from loguru import logger
 from huggingface_hub import whoami
 
@@ -14,6 +15,18 @@ from yourbench_space.utils import (
     save_files,
 )
 
+# Short project description
+project_description = """
+# YourBench 🚀  
+A Dynamic Benchmark Generation Framework 
+- Produce diverse, up-to-date questions from real-world source documents
+- Seamlessly handles ingestion, summarization, and multi-hop chunking for large or specialized datasets
+- Emulates real-world usage scenarios by creating fresh tasks that guard against memorized knowledge
+- Out-of-the-box pipeline stages, plus an easy plugin mechanism to accommodate custom models or domain constraints
+
+[📖 Github Page](https://github.com/huggingface/yourbench/tree/v0.2-alpha-space)
+"""
+
 UPLOAD_DIRECTORY.mkdir(parents=True, exist_ok=True)
 
 logger.remove()
@@ -22,9 +35,20 @@ logger.add(sys.stderr, level="INFO")
 command = ["uv", "run", "yourbench", f"--config={CONFIG_PATH}"]
 manager = SubprocessManager(command)
 
+# Create a citation section
+docs_path = Path(__file__).parent / "docs.md"
+
+# Read the file safely
+if docs_path.exists():
+    docs_content = docs_path.read_text()
+else:
+    docs_content = "# Citation\n\nDocumentation file not found."
+
+citation_content = docs_content.split("# Citation")[-1].strip()
+
 def generate_and_return(hf_org, hf_prefix):
     """Handles config generation and validates file existence before enabling download"""
-    generate_and_save_config(hf_org, hf_prefix)  # No need to store the return value
+    generate_and_save_config(hf_org, hf_prefix)
 
     # Wait until the config file is actually created
     for _ in range(5):
@@ -68,6 +92,8 @@ def enable_button(files):
 
 
 with gr.Blocks() as app:
+    gr.Markdown(project_description)
+
     gr.Markdown("## YourBench Setup")
     
     with gr.Row():
@@ -118,4 +144,9 @@ with gr.Blocks() as app:
             kill_button = gr.Button("Kill Task")
             kill_button.click(manager.kill_process)
 
+    # Citation section at the end
+    with gr.Accordion("📜 Citation", open=False):
+        gr.Markdown(citation_content)
+
+
 app.launch(allowed_paths=["/app"])

yourbench_space/docs.md

@@ -0,0 +1,10 @@
+# Citation
+
+If you use YourBench in your work, please cite:
+
+```bibtex
+@misc{yourbench,
+  author = { },
+  title = {YourBench: A Dynamic Benchmark Generation Framework},
+  year = {2025},
+}