tfrere commited on
Commit
c78d2a1
·
1 Parent(s): 953a39e
client/src/pages/HowToSubmitPage/HowToSubmitPage.jsx CHANGED
@@ -125,6 +125,21 @@ const CodeBlock = ({ children }) => (
125
  borderRadius: 1,
126
  fontFamily: "monospace",
127
  mb: 2,
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
128
  }}
129
  >
130
  {children}
@@ -135,21 +150,38 @@ const HowToSubmitPage = () => {
135
  return (
136
  <Box sx={{ width: "100%", maxWidth: 1200, margin: "0 auto", padding: 4 }}>
137
  <PageHeader
138
- title="How to Submit"
139
  subtitle={
140
  <>
141
- How to <span style={{ fontWeight: 600 }}>be a part</span> of{" "}
142
  <span style={{ fontWeight: 600 }}>"leaderboards on the Hub"</span>
143
  </>
144
  }
145
  />
146
 
147
- <Section title="How to submit your leaderboard?">
148
  <Stack spacing={4}>
149
  <Typography variant="body1" color="text.secondary">
150
- To be listed on this explorer, your leaderboard must be hosted on a
151
- Hugging Face Space. Follow these steps to make your Space
152
- discoverable:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
153
  </Typography>
154
 
155
  <Box
@@ -160,34 +192,73 @@ const HowToSubmitPage = () => {
160
  position: "relative",
161
  }}
162
  >
163
- <Box sx={{ flex: 1 }}>
164
- <Stack spacing={3}>
165
- <Stack direction="row" spacing={2} alignItems="center">
166
- <StepNumber number={1} />
167
- <Typography
168
- variant="subtitle1"
169
- sx={{
170
- fontWeight: 600,
171
- color: "text.primary",
172
- letterSpacing: "-0.01em",
173
- }}
174
- >
175
- Is it an Arena or a Leaderboard ?
176
- </Typography>
177
- </Stack>
178
- <Box sx={{ pl: 7 }}>
179
- <Stack spacing={2}>
180
  <Typography variant="body2" color="text.secondary">
181
  Add either the <strong>leaderboard</strong> or{" "}
182
- <strong>arena</strong> tag to your README.md:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
183
  </Typography>
184
- <CodeBlock>
185
- tags:
186
- <br />
187
- &nbsp;&nbsp;- leaderboard # or arena
188
- </CodeBlock>
189
  </Stack>
190
- </Box>
 
 
 
 
 
 
191
  </Stack>
192
  </Box>
193
 
@@ -199,93 +270,65 @@ const HowToSubmitPage = () => {
199
  }}
200
  />
201
 
202
- <Box sx={{ flex: 1 }}>
203
- <Stack spacing={3}>
204
- <Stack direction="row" spacing={2} alignItems="center">
205
- <StepNumber number={2} />
206
- <Typography
207
- variant="subtitle1"
208
- sx={{
209
- fontWeight: 600,
210
- color: "text.primary",
211
- letterSpacing: "-0.01em",
212
- }}
213
- >
214
- Describe it briefly
215
- </Typography>
216
- </Stack>
217
- <Box sx={{ pl: 7 }}>
218
- <Stack spacing={2}>
219
- <Typography variant="body2" color="text.secondary">
220
- Include a <strong>short_description</strong> field in your
221
- README.md.
222
- </Typography>
223
- <CodeBlock>
224
- short_description: Evaluating LLMs on math reasoning tasks
225
- </CodeBlock>
226
- </Stack>
227
- </Box>
228
- </Stack>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
229
  </Box>
230
  </Box>
231
-
232
- <Divider />
233
-
234
- <Box>
235
- <Stack spacing={3}>
236
- <Stack direction="row" spacing={2} alignItems="center">
237
- <StepNumber number={3} />
238
- <Typography
239
- variant="subtitle1"
240
- sx={{
241
- fontWeight: 600,
242
- color: "text.primary",
243
- letterSpacing: "-0.01em",
244
- }}
245
- >
246
- Add relevant tags
247
- </Typography>
248
- </Stack>
249
- <Box sx={{ pl: 7 }}>
250
- <Stack spacing={2}>
251
- <Typography variant="body2" color="text.secondary">
252
- Add relevant tags from these categories to help users find
253
- and understand your leaderboard.
254
- </Typography>
255
- <CodeBlock>
256
- tags:
257
- <br />
258
- &nbsp;&nbsp;- leaderboard
259
- <br />
260
- &nbsp;&nbsp;- submission:automatic &nbsp;&nbsp;# How models
261
- are submitted
262
- <br />
263
- &nbsp;&nbsp;- test:public
264
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
265
- Test set visibility
266
- <br />
267
- &nbsp;&nbsp;- judge:function
268
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
269
- Evaluation method
270
- <br />
271
- &nbsp;&nbsp;- modality:text
272
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
273
- Input/output type
274
- <br />
275
- &nbsp;&nbsp;- language:english
276
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Language coverage
277
- <br />
278
- &nbsp;&nbsp;- domain:financial
279
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Specific domain
280
- </CodeBlock>
281
- <Typography variant="body2" color="text.secondary">
282
- See the complete list of available tags and their meanings
283
- below.
284
- </Typography>
285
- </Stack>
286
- </Box>
287
- </Stack>
288
- </Box>
289
  </Stack>
290
  </Section>
291
 
 
125
  borderRadius: 1,
126
  fontFamily: "monospace",
127
  mb: 2,
128
+ "& .key": {
129
+ color: (theme) => theme.palette.primary.main,
130
+ },
131
+ "& .value": {
132
+ color: (theme) =>
133
+ theme.palette.mode === "dark"
134
+ ? theme.palette.success.light
135
+ : theme.palette.success.dark,
136
+ },
137
+ "& .comment": {
138
+ color: (theme) => theme.palette.text.secondary,
139
+ },
140
+ "& .punctuation": {
141
+ color: (theme) => theme.palette.text.primary,
142
+ },
143
  }}
144
  >
145
  {children}
 
150
  return (
151
  <Box sx={{ width: "100%", maxWidth: 1200, margin: "0 auto", padding: 4 }}>
152
  <PageHeader
153
+ title="How to submit ?"
154
  subtitle={
155
  <>
156
+ Join the <span style={{ fontWeight: 600 }}>community</span> of{" "}
157
  <span style={{ fontWeight: 600 }}>"leaderboards on the Hub"</span>
158
  </>
159
  }
160
  />
161
 
162
+ <Section title="Configuration steps">
163
  <Stack spacing={4}>
164
  <Typography variant="body1" color="text.secondary">
165
+ Your leaderboard must be hosted on a{" "}
166
+ <Link
167
+ href="https://huggingface.co/docs/hub/spaces"
168
+ target="_blank"
169
+ rel="noopener noreferrer"
170
+ >
171
+ Hugging Face Space
172
+ </Link>
173
+ .
174
+ <br />
175
+ Like{" "}
176
+ <Link
177
+ href="https://huggingface.co/docs/hub/model-cards"
178
+ target="_blank"
179
+ rel="noopener noreferrer"
180
+ >
181
+ model cards
182
+ </Link>
183
+ , your Space's <strong>README.md</strong> file should include
184
+ specific <strong>metadata</strong> in a YAML section at the top.
185
  </Typography>
186
 
187
  <Box
 
192
  position: "relative",
193
  }}
194
  >
195
+ <Box sx={{ flex: 4 }}>
196
+ <Stack spacing={4}>
197
+ <Stack spacing={3}>
198
+ <Stack direction="row" spacing={2} alignItems="center">
199
+ <StepNumber number={1} />
200
+ <Typography
201
+ variant="subtitle1"
202
+ sx={{
203
+ fontWeight: 600,
204
+ color: "text.primary",
205
+ letterSpacing: "-0.01em",
206
+ }}
207
+ >
208
+ Define the type
209
+ </Typography>
210
+ </Stack>
211
+ <Box sx={{ pl: 7 }}>
212
  <Typography variant="body2" color="text.secondary">
213
  Add either the <strong>leaderboard</strong> or{" "}
214
+ <strong>arena</strong> tag.
215
+ </Typography>
216
+ </Box>
217
+ </Stack>
218
+
219
+ <Stack spacing={3}>
220
+ <Stack direction="row" spacing={2} alignItems="center">
221
+ <StepNumber number={2} />
222
+ <Typography
223
+ variant="subtitle1"
224
+ sx={{
225
+ fontWeight: 600,
226
+ color: "text.primary",
227
+ letterSpacing: "-0.01em",
228
+ }}
229
+ >
230
+ Add a description
231
+ </Typography>
232
+ </Stack>
233
+ <Box sx={{ pl: 7 }}>
234
+ <Typography variant="body2" color="text.secondary">
235
+ Include a <strong>short_description</strong> field to
236
+ explain the purpose of your evaluation.
237
+ </Typography>
238
+ </Box>
239
+ </Stack>
240
+
241
+ <Stack spacing={3}>
242
+ <Stack direction="row" spacing={2} alignItems="center">
243
+ <StepNumber number={3} />
244
+ <Typography
245
+ variant="subtitle1"
246
+ sx={{
247
+ fontWeight: 600,
248
+ color: "text.primary",
249
+ letterSpacing: "-0.01em",
250
+ }}
251
+ >
252
+ Specify metadata
253
  </Typography>
 
 
 
 
 
254
  </Stack>
255
+ <Box sx={{ pl: 7 }}>
256
+ <Typography variant="body2" color="text.secondary">
257
+ Add <strong>metadata tags</strong> to categorize your
258
+ evaluation and help users understand its characteristics.
259
+ </Typography>
260
+ </Box>
261
+ </Stack>
262
  </Stack>
263
  </Box>
264
 
 
270
  }}
271
  />
272
 
273
+ <Box sx={{ flex: 5 }}>
274
+ <CodeBlock>
275
+ ---
276
+ <br />
277
+ <span className="key">short_description</span>
278
+ <span className="punctuation">:</span>{" "}
279
+ <span className="value">
280
+ Evaluating LLMs on math reasoning tasks
281
+ </span>
282
+ <br />
283
+ <span className="key">tags</span>
284
+ <span className="punctuation">:</span>
285
+ <br />
286
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
287
+ <span className="value">leaderboard</span>
288
+ <span className="comment">
289
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
290
+ Type of leaderboard
291
+ </span>
292
+ <br />
293
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
294
+ <span className="value">submission:automatic</span>{" "}
295
+ <span className="comment"># How models are submitted</span>
296
+ <br />
297
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
298
+ <span className="value">test:public</span>{" "}
299
+ <span className="comment">
300
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Test
301
+ set visibility
302
+ </span>
303
+ <br />
304
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
305
+ <span className="value">judge:function</span>{" "}
306
+ <span className="comment">
307
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Evaluation method
308
+ </span>
309
+ <br />
310
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
311
+ <span className="value">modality:text</span>{" "}
312
+ <span className="comment">
313
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Input/output type
314
+ </span>
315
+ <br />
316
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
317
+ <span className="value">language:english</span>{" "}
318
+ <span className="comment">
319
+ &nbsp;&nbsp;&nbsp;&nbsp;# Language coverage
320
+ </span>
321
+ <br />
322
+ <span className="punctuation">&nbsp;&nbsp;-</span>{" "}
323
+ <span className="value">domain:financial</span>{" "}
324
+ <span className="comment">
325
+ &nbsp;&nbsp;&nbsp;&nbsp;# Specific domain
326
+ </span>
327
+ <br />
328
+ ---
329
+ </CodeBlock>
330
  </Box>
331
  </Box>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
332
  </Stack>
333
  </Section>
334