KuriT commited on
Commit
ddce0fb
1 Parent(s): 87cf029

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +142 -1
README.md CHANGED
@@ -301,4 +301,145 @@ language:
301
  - en
302
  size_categories:
303
  - 1K<n<10K
304
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
301
  - en
302
  size_categories:
303
  - 1K<n<10K
304
+ ---
305
+ # Dataset Card for GitHub Issues (experiment)
306
+
307
+ <!-- Provide a quick summary of the dataset. -->
308
+
309
+ <!-- This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1). -->
310
+ GitHub Issues is a dataset consisting of GitHub issues and pull requests associated with the 🤗 Datasets repository. It is intended for educational purposes and can be used for semantic search or multilabel text classification. The contents of each GitHub issue are in English and concern the domain of datasets for NLP, computer vision, and beyond.
311
+
312
+
313
+ ## Dataset Details
314
+
315
+ ### Dataset Description
316
+
317
+ <!-- Provide a longer summary of what this dataset is. -->
318
+
319
+
320
+
321
+ - **Curated by:** [More Information Needed]
322
+ - **Funded by [optional]:** [More Information Needed]
323
+ - **Shared by [optional]:** [More Information Needed]
324
+ - **Language(s) (NLP):** [More Information Needed]
325
+ - **License:** [More Information Needed]
326
+
327
+ ### Dataset Sources [optional]
328
+
329
+ <!-- Provide the basic links for the dataset. -->
330
+
331
+ Use the GitHub API for issues. ![](https://docs.github.com/en/rest)
332
+ <!-- - **Repository:** [More Information Needed]
333
+ - **Paper [optional]:** [More Information Needed]
334
+ - **Demo [optional]:** [More Information Needed]
335
+ -->
336
+ ## Uses
337
+ Use the data for text classification and sematic search practice
338
+
339
+ <!-- Address questions around how the dataset is intended to be used. -->
340
+
341
+ ### Direct Use
342
+
343
+ <!-- This section describes suitable use cases for the dataset. -->
344
+
345
+ [More Information Needed]
346
+
347
+ ### Out-of-Scope Use
348
+
349
+ <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
350
+
351
+ [More Information Needed]
352
+
353
+ ## Dataset Structure
354
+
355
+ <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
356
+
357
+ [More Information Needed]
358
+
359
+ ## Dataset Creation
360
+
361
+ ### Curation Rationale
362
+
363
+ <!-- Motivation for the creation of this dataset. -->
364
+
365
+ [More Information Needed]
366
+
367
+ ### Source Data
368
+
369
+ <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
370
+
371
+ #### Data Collection and Processing
372
+
373
+ <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
374
+
375
+ [More Information Needed]
376
+
377
+ #### Who are the source data producers?
378
+
379
+ <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
380
+
381
+ [More Information Needed]
382
+
383
+ ### Annotations [optional]
384
+
385
+ <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
386
+
387
+ #### Annotation process
388
+
389
+ <!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
390
+
391
+ [More Information Needed]
392
+
393
+ #### Who are the annotators?
394
+
395
+ <!-- This section describes the people or systems who created the annotations. -->
396
+
397
+ [More Information Needed]
398
+
399
+ #### Personal and Sensitive Information
400
+
401
+ <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
402
+
403
+ [More Information Needed]
404
+
405
+ ## Bias, Risks, and Limitations
406
+
407
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
408
+
409
+ [More Information Needed]
410
+
411
+ ### Recommendations
412
+
413
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
414
+
415
+ Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
416
+
417
+ ## Citation [optional]
418
+
419
+ <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
420
+
421
+ **BibTeX:**
422
+
423
+ [More Information Needed]
424
+
425
+ **APA:**
426
+
427
+ [More Information Needed]
428
+
429
+ ## Glossary [optional]
430
+
431
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
432
+
433
+ [More Information Needed]
434
+
435
+ ## More Information [optional]
436
+
437
+ [More Information Needed]
438
+
439
+ ## Dataset Card Authors [optional]
440
+
441
+ [More Information Needed]
442
+
443
+ ## Dataset Card Contact
444
+
445
+ [More Information Needed]