lewtun/github-issues

1# Dataset Card for GitHub Issues2 3## Dataset Description4 5- **Point of Contact:** [Lewis Tunstall](lewis@huggingface.co)6 7### Dataset Summary8 9GitHub Issues is a dataset consisting of GitHub issues and pull requests associated with the 🤗 Datasets [repository](https://github.com/huggingface/datasets). 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.10 11### Supported Tasks and Leaderboards12 13For each of the tasks tagged for this dataset, give a brief description of the tag, metrics, and suggested models (with a link to their HuggingFace implementation if available). Give a similar description of tasks that were not covered by the structured tag set (repace the `task-category-tag` with an appropriate `other:other-task-name`).14 15- `task-category-tag`: The dataset can be used to train a model for [TASK NAME], which consists in [TASK DESCRIPTION]. Success on this task is typically measured by achieving a *high/low* [metric name](https://huggingface.co/metrics/metric_name). The ([model name](https://huggingface.co/model_name) or [model class](https://huggingface.co/transformers/model_doc/model_class.html)) model currently achieves the following score. *[IF A LEADERBOARD IS AVAILABLE]:* This task has an active leaderboard which can be found at [leaderboard url]() and ranks models based on [metric name](https://huggingface.co/metrics/metric_name) while also reporting [other metric name](https://huggingface.co/metrics/other_metric_name).16 17### Languages18 19Provide a brief overview of the languages represented in the dataset. Describe relevant details about specifics of the language such as whether it is social media text, African American English,...20 21When relevant, please provide [BCP-47 codes](https://tools.ietf.org/html/bcp47), which consist of a [primary language subtag](https://tools.ietf.org/html/bcp47#section-2.2.1), with a [script subtag](https://tools.ietf.org/html/bcp47#section-2.2.3) and/or [region subtag](https://tools.ietf.org/html/bcp47#section-2.2.4) if available.22 23## Dataset Structure24 25### Data Instances26 27Provide an JSON-formatted example and brief description of a typical instance in the dataset. If available, provide a link to further examples.28 29```30{31  'example_field': ...,32  ...33}34```35 36Provide any additional information that is not covered in the other sections about the data here. In particular describe any relationships between data points and if these relationships are made explicit.37 38### Data Fields39 40List and describe the fields present in the dataset. Mention their data type, and whether they are used as input or output in any of the tasks the dataset currently supports. If the data has span indices, describe their attributes, such as whether they are at the character level or word level, whether they are contiguous or not, etc. If the datasets contains example IDs, state whether they have an inherent meaning, such as a mapping to other datasets or pointing to relationships between data points.41 42- `example_field`: description of `example_field`43 44Note that the descriptions can be initialized with the **Show Markdown Data Fields** output of the [tagging app](https://github.com/huggingface/datasets-tagging), you will then only need to refine the generated descriptions.45 46### Data Splits47 48Describe and name the splits in the dataset if there are more than one.49 50Describe any criteria for splitting the data, if used. If their are differences between the splits (e.g. if the training annotations are machine-generated and the dev and test ones are created by humans, or if different numbers of annotators contributed to each example), describe them here.51 52Provide the sizes of each split. As appropriate, provide any descriptive statistics for the features, such as average length.  For example:53 54|                            | Tain   | Valid | Test |55| -----                      | ------ | ----- | ---- |56| Input Sentences            |        |       |      |57| Average Sentence Length    |        |       |      |58 59## Dataset Creation60 61### Curation Rationale62 63What need motivated the creation of this dataset? What are some of the reasons underlying the major choices involved in putting it together?64 65### Source Data66 67This section describes the source data (e.g. news text and headlines, social media posts, translated sentences,...)68 69#### Initial Data Collection and Normalization70 71Describe the data collection process. Describe any criteria for data selection or filtering. List any key words or search terms used. If possible, include runtime information for the collection process.72 73If data was collected from other pre-existing datasets, link to source here and to their [Hugging Face version](https://huggingface.co/datasets/dataset_name).74 75If the data was modified or normalized after being collected (e.g. if the data is word-tokenized), describe the process and the tools used.76 77#### Who are the source language producers?78 79State whether the data was produced by humans or machine generated. Describe the people or systems who originally created the data.80 81If available, include self-reported demographic or identity information for the source data creators, but avoid inferring this information. Instead state that this information is unknown. See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender.82 83Describe the conditions under which the data was created (for example, if the producers were crowdworkers, state what platform was used, or if the data was found, what website the data was found on). If compensation was provided, include that information here.84 85Describe other people represented or mentioned in the data. Where possible, link to references for the information.86 87### Annotations88 89If the dataset contains annotations which are not part of the initial data collection, describe them in the following paragraphs.90 91#### Annotation process92 93If applicable, describe the annotation process and any tools used, or state otherwise. Describe the amount of data annotated, if not all. Describe or reference annotation guidelines provided to the annotators. If available, provide interannotator statistics. Describe any annotation validation processes.94 95#### Who are the annotators?96 97If annotations were collected for the source data (such as class labels or syntactic parses), state whether the annotations were produced by humans or machine generated.98 99Describe the people or systems who originally created the annotations and their selection criteria if applicable.100 101If available, include self-reported demographic or identity information for the annotators, but avoid inferring this information. Instead state that this information is unknown. See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender.102 103Describe the conditions under which the data was annotated (for example, if the annotators were crowdworkers, state what platform was used, or if the data was found, what website the data was found on). If compensation was provided, include that information here.104 105### Personal and Sensitive Information106 107State whether the dataset uses identity categories and, if so, how the information is used. Describe where this information comes from (i.e. self-reporting, collecting from profiles, inferring, etc.). See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender. State whether the data is linked to individuals and whether those individuals can be identified in the dataset, either directly or indirectly (i.e., in combination with other data).108 109State whether the dataset contains other data that might be considered sensitive (e.g., data that reveals racial or ethnic origins, sexual orientations, religious beliefs, political opinions or union memberships, or locations; financial or health data; biometric or genetic data; forms of government identification, such as social security numbers; criminal history).  110 111If efforts were made to anonymize the data, describe the anonymization process.112 113## Considerations for Using the Data114 115### Social Impact of Dataset116 117Please discuss some of the ways you believe the use of this dataset will impact society.118 119The statement should include both positive outlooks, such as outlining how technologies developed through its use may improve people's lives, and discuss the accompanying risks. These risks may range from making important decisions more opaque to people who are affected by the technology, to reinforcing existing harmful biases (whose specifics should be discussed in the next section), among other considerations.120 121Also describe in this section if the proposed dataset contains a low-resource or under-represented language. If this is the case or if this task has any impact on underserved communities, please elaborate here.122 123### Discussion of Biases124 125Provide descriptions of specific biases that are likely to be reflected in the data, and state whether any steps were taken to reduce their impact.126 127For Wikipedia text, see for example [Dinan et al 2020 on biases in Wikipedia (esp. Table 1)](https://arxiv.org/abs/2005.00614), or [Blodgett et al 2020](https://www.aclweb.org/anthology/2020.acl-main.485/) for a more general discussion of the topic.128 129If analyses have been run quantifying these biases, please add brief summaries and links to the studies here.130 131### Other Known Limitations132 133If studies of the datasets have outlined other limitations of the dataset, such as annotation artifacts, please outline and cite them here.134 135## Additional Information136 137### Dataset Curators138 139List the people involved in collecting the dataset and their affiliation(s). If funding information is known, include it here.140 141### Licensing Information142 143Provide the license and link to the license webpage if available.144 145### Citation Information146 147Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:148```149@article{article_id,150  author    = {Author List},151  title     = {Dataset Paper Title},152  journal   = {Publication Venue},153  year      = {2525}154}155```156 157If the dataset has a [DOI](https://www.doi.org/), please provide it here.158 159### Contributions160 161Thanks to [@lewtun](https://github.com/lewtun) for adding this dataset.