update

src/display/about.py

@@ -96,16 +96,78 @@ If there is no icon, we have not uploaded the information on the model yet, feel
 FAQ_TEXT = """
 ---------------------------
 # FAQ
+Below are some common questions - if this FAQ does not answer you, feel free to create a new issue, and we'll take care of it as soon as we can! 
+
 ## 1) Submitting a model
-XXX
+My model requires `trust_remote_code=True`, can I submit it?
+- *We only support models that have been integrated in a stable version of the `transformers` library for automatic submission, as we don't want to run possibly unsage code on our cluster.*
+What about models of type X? 
+- *We only support models that have been integrated in a stable version of the `transformers` library for automatic submission.*
+How can I follow when my model is launched?
+- *You can look for its request file [here](https://huggingface.co/datasets/hallucinations-leaderboard/requests) and follow the status evolution, or directly in the queues above the submit form.*
+My model disappeared from all the queues, what happened?
+- *A model disappearing from all the queues usually means that there has been a failure. You can check if that is the case by looking for your model [here](https://huggingface.co/datasets/hallucinations-leaderboard/requests).*
+What causes an evaluation failure?
+- *Most of the failures we get come from problems in the submissions (corrupted files, config problems, wrong parameters selected for eval ...), so we'll be grateful if you first make sure you have followed the steps in `About`. However, from time to time, we have failures on our side (hardware/node failures, problem with an update of our backend, connectivity problem ending up in the results not being saved, ...).*
+How can I report an evaluation failure?
+- *As we store the logs for all models, feel free to create an issue, **where you link to the requests file of your model** (look for it [here](https://huggingface.co/datasets/hallucinations-leaderboard/requests/tree/main)), so we can investigate! If the model failed due to a problem on our side, we'll relaunch it right away!* 
+*Note: Please do not re-upload your model under a different name, it will not help*
+
 ## 2) Model results
-XXX
+What kind of information can I find?
+- *Let's imagine you are interested in the Yi-34B results. You have access to 3 different information categories:*
+      - *The [request file](https://huggingface.co/datasets/hallucinations-leaderboard/requests/blob/main/01-ai/Yi-34B_eval_request_False_bfloat16_Original.json): it gives you information about the status of the evaluation*
+      - *The [aggregated results folder](https://huggingface.co/datasets/hallucinations-leaderboard/results/tree/main/01-ai/Yi-34B): it gives you aggregated scores, per experimental run*
+Why do models appear several times in the leaderboard? 
+- *We run evaluations with user selected precision and model commit. Sometimes, users submit specific models at different commits and at different precisions (for example, in float16 and 4bit to see how quantization affects performance). You should be able to verify this by displaying the `precision` and `model sha` columns in the display. If, however, you see models appearing several time with the same precision and hash commit, this is not normal.*
+What is this concept of "flagging"?
+- *This mechanism allows user to report models that have unfair performance on the leaderboard. This contains several categories: exceedingly good results on the leaderboard because the model was (maybe accidentally) trained on the evaluation data, models that are copy of other models not atrributed properly, etc.*
+My model has been flagged improperly, what can I do?
+- *Every flagged model has a discussion associated with it - feel free to plead your case there, and we'll see what to do together with the community.*
+
 ## 3) Editing a submission
-XXX
+I upgraded my model and want to re-submit, how can I do that?
+- *Please open an issue with the precise name of your model, and we'll remove your model from the leaderboard so you can resubmit. You can also resubmit directly with the new commit hash!* 
+
+## 4) Other
+Why don't you display closed source model scores? 
+- *This is a leaderboard for Open models, both for philosophical reasons (openness is cool) and for practical reasons: we want to ensure that the results we display are accurate and reproducible, but 1) commercial closed models can change their API thus rendering any scoring at a given time incorrect 2) we re-run everything on our cluster to ensure all models are run on the same setup and you can't do that for these models.*
+I have an issue about accessing the leaderboard through the Gradio API
+- *Since this is not the recommended way to access the leaderboard, we won't provide support for this, but you can look at tools provided by the community for inspiration!*
 """
 
 EVALUATION_QUEUE_TEXT = """
-XXX
+# Evaluation Queue for the Hallucinations Leaderboard
+Models added here will be automatically evaluated on the EIDF cluster.
+
+## First steps before submitting a model
+### 1) Make sure you can load your model and tokenizer using AutoClasses:
+```python
+from transformers import AutoConfig, AutoModel, AutoTokenizer
+config = AutoConfig.from_pretrained("your model name", revision=revision)
+model = AutoModel.from_pretrained("your model name", revision=revision)
+tokenizer = AutoTokenizer.from_pretrained("your model name", revision=revision)
+```
+If this step fails, follow the error messages to debug your model before submitting it. It's likely your model has been improperly uploaded.
+Note: make sure your model is public!
+Note: if your model needs `use_remote_code=True`, we do not support this option yet but we are working on adding it, stay posted!
+
+### 2) Convert your model weights to [safetensors](https://huggingface.co/docs/safetensors/index)
+It's a new format for storing weights which is safer and faster to load and use. It will also allow us to add the number of parameters of your model to the `Extended Viewer`!
+
+### 3) Make sure your model has an open license!
+This is a leaderboard for Open LLMs, and we'd love for as many people as possible to know they can use your model 🤗
+
+### 4) Fill up your model card
+When we add extra information about models to the leaderboard, it will be automatically taken from the model card
+
+### 5) Select the correct precision
+Not all models are converted properly from `float16` to `bfloat16`, and selecting the wrong precision can sometimes cause evaluation error (as loading a `bf16` model in `fp16` can sometimes generate NaNs, depending on the weight range).
+
+## In case of model failure
+If your model is displayed in the `FAILED` category, its execution stopped.
+Make sure you have followed the above steps first.
+If everything is done, check you can launch the EleutherAIHarness on your model locally, using the command in the About tab under "Reproducibility" with all arguments specified (you can add `--limit` to limit the number of examples per task).
 """
 
 CITATION_BUTTON_LABEL = "Copy the following snippet to cite these results"
@@ -117,4 +179,29 @@ CITATION_BUTTON_TEXT = r"""
   publisher = {Hugging Face},
   howpublished = "\url{https://huggingface.co/spaces/hallucinations-leaderboard/leaderboard}"
 }
+
+@software{eval-harness,
+  author       = {Gao, Leo and
+                  Tow, Jonathan and
+                  Biderman, Stella and
+                  Black, Sid and
+                  DiPofi, Anthony and
+                  Foster, Charles and
+                  Golding, Laurence and
+                  Hsu, Jeffrey and
+                  McDonell, Kyle and
+                  Muennighoff, Niklas and
+                  Phang, Jason and
+                  Reynolds, Laria and
+                  Tang, Eric and
+                  Thite, Anish and
+                  Wang, Ben and
+                  Wang, Kevin and
+                  Zou, Andy},
+  title        = {A framework for few-shot language model evaluation},
+  month        = sep,
+  year         = 2021,
+  publisher    = {Zenodo},
+  version      = {v0.0.1},
+  doi          = {10.
 """