Spaces:
Running
Running
File size: 16,069 Bytes
5470817 953a39e 5470817 953a39e 5470817 c78d2a1 5470817 c78d2a1 5470817 c78d2a1 953a39e 5470817 c78d2a1 953a39e c78d2a1 5470817 953a39e c78d2a1 953a39e c78d2a1 953a39e c78d2a1 953a39e c78d2a1 953a39e 5470817 953a39e 5470817 953a39e 5470817 953a39e 5470817 953a39e 5470817 953a39e 5470817 953a39e 5470817 953a39e 5470817 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
import React from "react";
import {
Box,
Typography,
Paper,
Stack,
Divider,
alpha,
Link,
} from "@mui/material";
import PageHeader from "../../components/PageHeader/PageHeader";
const StepNumber = ({ number }) => (
<Box
sx={{
width: 32,
height: 32,
borderRadius: "50%",
display: "flex",
alignItems: "center",
justifyContent: "center",
border: "1px solid",
borderColor: "primary.main",
color: "primary.main",
fontSize: "0.875rem",
fontWeight: 600,
flexShrink: 0,
bgcolor: "transparent",
}}
>
{number}
</Box>
);
const Section = ({ title, children }) => (
<Paper
elevation={0}
sx={{
border: "1px solid",
borderColor: "grey.300",
borderRadius: 1,
overflow: "hidden",
mb: 3,
}}
>
<Box
sx={{
px: 3,
py: 2,
borderBottom: "1px solid",
borderColor: (theme) =>
theme.palette.mode === "dark"
? alpha(theme.palette.divider, 0.1)
: "grey.200",
bgcolor: (theme) =>
theme.palette.mode === "dark"
? alpha(theme.palette.background.paper, 0.5)
: "grey.50",
}}
>
<Typography variant="h6" sx={{ fontWeight: 600, color: "text.primary" }}>
{title}
</Typography>
</Box>
<Box sx={{ p: 3, bgcolor: "background.paper" }}>{children}</Box>
</Paper>
);
const Tag = ({ children }) => (
<Box
component="span"
sx={{
display: "inline-block",
px: 1.5,
py: 0.5,
bgcolor: (theme) => alpha(theme.palette.primary.main, 0.1),
color: "primary.main",
borderRadius: 1,
fontSize: "0.875rem",
fontWeight: 600,
mr: 1,
mb: 1,
}}
>
{children}
</Box>
);
const TagSection = ({ title, description, tags, explanations }) => (
<Box sx={{ mb: 4 }}>
<Typography variant="h6" sx={{ fontWeight: 600, mb: 1 }}>
{title}
</Typography>
{description && (
<Typography variant="body1" sx={{ mb: 2, color: "text.secondary" }}>
{description}
</Typography>
)}
<Stack spacing={1}>
{tags.map((tag, index) => (
<Box key={index}>
<Tag>{tag}</Tag>
{explanations && explanations[index] && (
<Typography
component="span"
variant="body2"
sx={{ color: "text.secondary", ml: 1 }}
dangerouslySetInnerHTML={{ __html: explanations[index] }}
/>
)}
</Box>
))}
</Stack>
</Box>
);
const CodeBlock = ({ children }) => (
<Box
sx={{
backgroundColor: (theme) =>
theme.palette.mode === "dark"
? "rgba(255, 255, 255, 0.05)"
: "rgba(0, 0, 0, 0.03)",
p: 2,
borderRadius: 1,
fontFamily: "monospace",
mb: 2,
"& .key": {
color: (theme) => theme.palette.primary.main,
},
"& .value": {
color: (theme) =>
theme.palette.mode === "dark"
? theme.palette.success.light
: theme.palette.success.dark,
},
"& .comment": {
color: (theme) => theme.palette.text.secondary,
},
"& .punctuation": {
color: (theme) => theme.palette.text.primary,
},
}}
>
{children}
</Box>
);
const HowToSubmitPage = () => {
return (
<Box sx={{ width: "100%", maxWidth: 1200, margin: "0 auto", padding: 4 }}>
<PageHeader
title="How to submit ?"
subtitle={
<>
Join the <span style={{ fontWeight: 600 }}>community</span> of{" "}
<span style={{ fontWeight: 600 }}>"leaderboards on the Hub"</span>
</>
}
/>
<Section title="Configuration steps">
<Stack spacing={4}>
<Typography variant="body1" color="text.secondary">
Your leaderboard must be hosted on a{" "}
<Link
href="https://huggingface.co/docs/hub/spaces"
target="_blank"
rel="noopener noreferrer"
>
Hugging Face Space
</Link>
.
<br />
Like{" "}
<Link
href="https://huggingface.co/docs/hub/model-cards"
target="_blank"
rel="noopener noreferrer"
>
model cards
</Link>
, your Space's <strong>README.md</strong> file should include
specific <strong>metadata</strong> in a YAML section at the top.
</Typography>
<Box
sx={{
display: "flex",
flexDirection: { xs: "column", md: "row" },
gap: 4,
position: "relative",
}}
>
<Box sx={{ flex: 4 }}>
<Stack spacing={4}>
<Stack spacing={3}>
<Stack direction="row" spacing={2} alignItems="center">
<StepNumber number={1} />
<Typography
variant="subtitle1"
sx={{
fontWeight: 600,
color: "text.primary",
letterSpacing: "-0.01em",
}}
>
Define the type
</Typography>
</Stack>
<Box sx={{ pl: 7 }}>
<Typography variant="body2" color="text.secondary">
Add either the <strong>leaderboard</strong> or{" "}
<strong>arena</strong> tag.
</Typography>
</Box>
</Stack>
<Stack spacing={3}>
<Stack direction="row" spacing={2} alignItems="center">
<StepNumber number={2} />
<Typography
variant="subtitle1"
sx={{
fontWeight: 600,
color: "text.primary",
letterSpacing: "-0.01em",
}}
>
Add a description
</Typography>
</Stack>
<Box sx={{ pl: 7 }}>
<Typography variant="body2" color="text.secondary">
Include a <strong>short_description</strong> field to
explain the purpose of your evaluation.
</Typography>
</Box>
</Stack>
<Stack spacing={3}>
<Stack direction="row" spacing={2} alignItems="center">
<StepNumber number={3} />
<Typography
variant="subtitle1"
sx={{
fontWeight: 600,
color: "text.primary",
letterSpacing: "-0.01em",
}}
>
Specify metadata
</Typography>
</Stack>
<Box sx={{ pl: 7 }}>
<Typography variant="body2" color="text.secondary">
Add <strong>metadata tags</strong> to categorize your
evaluation and help users understand its characteristics.
</Typography>
</Box>
</Stack>
</Stack>
</Box>
<Divider
orientation="vertical"
flexItem
sx={{
display: { xs: "none", md: "block" },
}}
/>
<Box sx={{ flex: 5 }}>
<CodeBlock>
---
<br />
<span className="key">short_description</span>
<span className="punctuation">:</span>{" "}
<span className="value">
Evaluating LLMs on math reasoning tasks
</span>
<br />
<span className="key">tags</span>
<span className="punctuation">:</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">leaderboard</span>
<span className="comment">
#
Type of leaderboard
</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">submission:automatic</span>{" "}
<span className="comment"># How models are submitted</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">test:public</span>{" "}
<span className="comment">
# Test
set visibility
</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">judge:function</span>{" "}
<span className="comment">
# Evaluation method
</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">modality:text</span>{" "}
<span className="comment">
# Input/output type
</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">language:english</span>{" "}
<span className="comment">
# Language coverage
</span>
<br />
<span className="punctuation"> -</span>{" "}
<span className="value">domain:financial</span>{" "}
<span className="comment">
# Specific domain
</span>
<br />
---
</CodeBlock>
</Box>
</Box>
</Stack>
</Section>
<Section title="What do the tags mean?">
<TagSection
title="Submission type"
description="Arenas are not concerned by this category."
tags={[
"submission:automatic",
"submission:semiautomatic",
"submission:manual",
"submission:closed",
]}
explanations={[
"users can submit their models as such to the leaderboard, and evaluation is run <strong>automatically</strong> without human intervention",
"the leaderboard requires the <strong>model owner</strong> to run evaluations on his side and submit the results",
"the leaderboard requires the <strong>leaderboard owner</strong> to run evaluations for new submissions",
"the leaderboard <strong>does not accept</strong> submissions at the moment",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Test set status"
description="Arenas are not concerned by this category."
tags={["test:public", "test:mix", "test:private", "test:rolling"]}
explanations={[
"all the test sets used are <strong>public</strong>, the evaluations are completely <strong>reproducible</strong>",
"some test sets are <strong>public</strong> and some <strong>private</strong>",
"all the test sets used are <strong>private</strong>, the evaluations are hard to game",
"the test sets used <strong>change regularly</strong> through time and evaluation scores are refreshed",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Judges"
tags={[
"judge:function",
"judge:model",
"judge:humans",
"judge:vibe_check",
]}
explanations={[
"evaluations are run <strong>automatically</strong>, using an evaluation suite such as <strong>lm_eval</strong> or <strong>lighteval</strong>",
"evaluations are run using a <strong>model as a judge</strong> approach to rate answer",
"evaluations are <strong>done by humans</strong> to rate answer - <strong>this is an arena</strong>",
"evaluations are <strong>done manually</strong> by one or several humans",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Modalities"
description="Can be any (or several) of the following list:"
tags={[
"modality:text",
"modality:image",
"modality:audio",
"modality:video",
"modality:tools",
"modality:artefacts",
]}
explanations={[
"",
"",
"",
"",
"requires added <strong>tool usage</strong> - mostly for <strong>assistant models</strong> (a bit outside of usual modalities)",
"the leaderboard concerns itself with <strong>machine learning artefacts</strong> as themselves, for example, quality evaluation of <strong>text embeddings</strong> (a bit outside of usual modalities)",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Evaluation categories"
description="Can be any (or several) of the following list:"
tags={[
"eval:generation",
"eval:math",
"eval:code",
"eval:performance",
"eval:safety",
"task:rag",
]}
explanations={[
"the evaluation looks at <strong>generation capabilities</strong> specifically (can be image generation, text generation, ...)",
"the evaluation tests <strong>math abilities</strong>",
"the evaluation tests <strong>coding capabilities</strong>",
"model <strong>performance</strong> (speed, energy consumption, ...)",
"the evaluation considers <strong>safety</strong>, <strong>toxicity</strong>, <strong>bias</strong>",
"the evaluation tests <strong>RAG</strong> (Retrieval-Augmented Generation) capabilities",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Language"
description="You can indicate the languages covered by your benchmark like so: language:mylanguage. At the moment, we do not support language codes, please use the language name in English."
tags={["language:english", "language:french"]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Domain"
description="Indicates the specific domain of the leaderboard:"
tags={["domain:financial", "domain:medical", "domain:legal"]}
/>
<Typography
variant="body2"
sx={{
mt: 1,
color: "text.secondary",
fontSize: "0.875rem",
fontStyle: "italic",
}}
>
If you would like to see a domain that is not currently represented,
please contact{" "}
<Link
href="https://huggingface.co/clementine"
target="_blank"
rel="noopener noreferrer"
sx={{
color: "primary.main",
textDecoration: "none",
"&:hover": {
textDecoration: "underline",
},
}}
>
Clementine Fourrier
</Link>{" "}
on Hugging Face.
</Typography>
</Section>
</Box>
);
};
export default HowToSubmitPage;
|