Spaces:
Running
Running
File size: 8,561 Bytes
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 |
import React from "react";
import {
Box,
Typography,
Paper,
Stack,
Divider,
alpha,
Link,
} from "@mui/material";
import PageHeader from "../../components/PageHeader/PageHeader";
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 }}
>
{explanations[index]}
</Typography>
)}
</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,
}}
>
{children}
</Box>
);
const HowToSubmitPage = () => {
return (
<Box sx={{ width: "100%", maxWidth: 1200, margin: "0 auto", padding: 4 }}>
<PageHeader
title="How to Submit"
subtitle={
<>
Learn how to <span style={{ fontWeight: 600 }}>be listed</span> on
the explorer
</>
}
/>
<Section title="How to submit your leaderboard?">
<Stack spacing={2}>
<Typography variant="body1">
Your space will appear automatically in the lists if it contains
correct metadata!
</Typography>
<Typography variant="body1">
Make sure to either use the tag leaderboard or arena to your space,
by adding the following to your README:
</Typography>
<CodeBlock>
tags:
<br />
- leaderboard
</CodeBlock>
<Typography variant="body1">
then any other tags of interest to you.
</Typography>
</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 automatically without human intervention",
"the leaderboard requires the model owner to run evaluations on his side and submit the results",
"the leaderboard requires the leaderboard owner to run evaluations for new submissions",
"the leaderboard does not accept 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 public, the evaluations are completely reproducible",
"some test sets are public and some private",
"all the test sets used are private, the evaluations are hard to game",
"the test sets used change regularly through time and evaluation scores are refreshed",
]}
/>
<Divider sx={{ my: 3 }} />
<TagSection
title="Judges"
tags={[
"judge:auto",
"judge:model",
"judge:humans",
"judge:vibe_check",
]}
explanations={[
"evaluations are run automatically, using an evaluation suite such as lm_eval or lighteval",
"evaluations are run using a model as a judge approach to rate answer",
"evaluations are done by humans to rate answer - this is an arena",
"evaluations are done manually 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 tool usage - mostly for assistant models (a bit outside of usual modalities)",
"the leaderboard concerns itself with machine learning artefacts as themselves, for example, quality evaluation of text embeddings (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",
]}
explanations={[
"the evaluation looks at generation capabilities specifically (can be image generation, text generation, ...)",
"the evaluation tests math abilities",
"the evaluation tests coding capabilities",
"model performance (speed, energy consumption, ...)",
"the evaluation considers safety, toxicity, bias",
]}
/>
<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>
<Divider sx={{ my: 3 }} />
</Section>
</Box>
);
};
export default HowToSubmitPage;
|