Duplicate from code-search-net/code_search_net

Co-authored-by: Parquet-converter (BOT) <parquet-converter@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,27 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,468 @@
+---
+annotations_creators:
+- no-annotation
+language_creators:
+- machine-generated
+language:
+- code
+license:
+- other
+multilinguality:
+- multilingual
+size_categories:
+- 100K<n<1M
+- 10K<n<100K
+- 1M<n<10M
+source_datasets:
+- original
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
+- masked-language-modeling
+paperswithcode_id: codesearchnet
+pretty_name: CodeSearchNet
+dataset_info:
+- config_name: all
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 5850604083
+    num_examples: 1880853
+  - name: test
+    num_bytes: 308626333
+    num_examples: 100529
+  - name: validation
+    num_bytes: 274564382
+    num_examples: 89154
+  download_size: 5117370511
+  dataset_size: 6433794798
+- config_name: java
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1429272535
+    num_examples: 454451
+  - name: test
+    num_bytes: 82377246
+    num_examples: 26909
+  - name: validation
+    num_bytes: 42358315
+    num_examples: 15328
+  download_size: 1060569153
+  dataset_size: 1554008096
+- config_name: go
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 738153234
+    num_examples: 317832
+  - name: test
+    num_bytes: 32286998
+    num_examples: 14291
+  - name: validation
+    num_bytes: 26888527
+    num_examples: 14242
+  download_size: 487525935
+  dataset_size: 797328759
+- config_name: python
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1559645310
+    num_examples: 412178
+  - name: test
+    num_bytes: 84342064
+    num_examples: 22176
+  - name: validation
+    num_bytes: 92154786
+    num_examples: 23107
+  download_size: 940909997
+  dataset_size: 1736142160
+- config_name: javascript
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 480286523
+    num_examples: 123889
+  - name: test
+    num_bytes: 24056972
+    num_examples: 6483
+  - name: validation
+    num_bytes: 30168242
+    num_examples: 8253
+  download_size: 1664713350
+  dataset_size: 534511737
+- config_name: ruby
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 110681715
+    num_examples: 48791
+  - name: test
+    num_bytes: 5359280
+    num_examples: 2279
+  - name: validation
+    num_bytes: 4830744
+    num_examples: 2209
+  download_size: 111758028
+  dataset_size: 120871739
+- config_name: php
+  features:
+  - name: repository_name
+    dtype: string
+  - name: func_path_in_repository
+    dtype: string
+  - name: func_name
+    dtype: string
+  - name: whole_func_string
+    dtype: string
+  - name: language
+    dtype: string
+  - name: func_code_string
+    dtype: string
+  - name: func_code_tokens
+    sequence: string
+  - name: func_documentation_string
+    dtype: string
+  - name: func_documentation_tokens
+    sequence: string
+  - name: split_name
+    dtype: string
+  - name: func_code_url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1532564870
+    num_examples: 523712
+  - name: test
+    num_bytes: 80203877
+    num_examples: 28391
+  - name: validation
+    num_bytes: 78163924
+    num_examples: 26015
+  download_size: 851894048
+  dataset_size: 1690932671
+config_names:
+- all
+- go
+- java
+- javascript
+- php
+- python
+- ruby
+---
+
+# Dataset Card for CodeSearchNet corpus
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+- **Homepage:** https://wandb.ai/github/CodeSearchNet/benchmark
+- **Repository:** https://github.com/github/CodeSearchNet
+- **Paper:** https://arxiv.org/abs/1909.09436
+- **Data:** https://doi.org/10.5281/zenodo.7908468
+- **Leaderboard:** https://wandb.ai/github/CodeSearchNet/benchmark/leaderboard
+
+### Dataset Summary
+
+CodeSearchNet corpus is a dataset of 2 milllion (comment, code) pairs from opensource libraries hosted on GitHub. It contains code and documentation for several programming languages.
+
+CodeSearchNet corpus was gathered to support the [CodeSearchNet challenge](https://wandb.ai/github/CodeSearchNet/benchmark), to explore the problem of code retrieval using natural language.
+
+### Supported Tasks and Leaderboards
+
+- `language-modeling`: The dataset can be used to train a model for modelling programming languages, which consists in building language models for programming languages.
+
+### Languages
+
+- Go **programming** language
+- Java **programming** language
+- Javascript **programming** language
+- PHP **programming** language
+- Python **programming** language
+- Ruby **programming** language
+
+## Dataset Structure
+
+### Data Instances
+
+A data point consists of a function code along with its documentation. Each data point also contains meta data on the function, such as the repository it was extracted from.
+```
+{
+  'id': '0',
+  'repository_name': 'organisation/repository',
+  'func_path_in_repository': 'src/path/to/file.py',
+  'func_name': 'func',
+  'whole_func_string': 'def func(args):\n"""Docstring"""\n [...]',
+  'language': 'python', 
+  'func_code_string': '[...]',
+  'func_code_tokens': ['def', 'func', '(', 'args', ')', ...],
+  'func_documentation_string': 'Docstring',
+  'func_documentation_string_tokens': ['Docstring'],
+  'split_name': 'train',
+  'func_code_url': 'https://github.com/<org>/<repo>/blob/<hash>/src/path/to/file.py#L111-L150'
+}
+```
+### Data Fields
+
+- `id`: Arbitrary number
+- `repository_name`: name of the GitHub repository
+- `func_path_in_repository`: tl;dr: path to the file which holds the function in the repository
+- `func_name`: name of the function in the file
+- `whole_func_string`: Code + documentation of the function
+- `language`: Programming language in whoch the function is written
+- `func_code_string`: Function code
+- `func_code_tokens`: Tokens yielded by Treesitter
+- `func_documentation_string`: Function documentation
+- `func_documentation_string_tokens`: Tokens yielded by Treesitter
+- `split_name`: Name of the split to which the example belongs (one of train, test or valid)
+- `func_code_url`: URL to the function code on Github
+
+### Data Splits
+
+Three splits are available:
+- train
+- test
+- valid
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+All information can be retrieved in the [original technical review](https://arxiv.org/pdf/1909.09436.pdf)
+
+**Corpus collection**:
+
+Corpus has been collected from publicly available open-source non-fork GitHub repositories, using libraries.io to identify all projects which are used by at least one other project, and sort them by “popularity” as indicated by the number of stars and forks. 
+
+Then, any projects that do not have a license or whose license does not explicitly permit the re-distribution of parts of the project were removed. Treesitter - GitHub's universal parser - has been used to then tokenize all Go, Java, JavaScript, Python, PHP and Ruby functions (or methods) using and, where available, their respective documentation text using a heuristic regular expression.
+
+**Corpus filtering**:
+
+Functions without documentation are removed from the corpus. This yields a set of pairs ($c_i$, $d_i$) where ci is some function documented by di. Pairs ($c_i$, $d_i$) are passed through the folllowing preprocessing tasks:
+
+- Documentation $d_i$ is truncated to the first full paragraph to remove in-depth discussion of function arguments and return values
+- Pairs in which $d_i$ is shorter than three tokens are removed
+- Functions $c_i$ whose implementation is shorter than three lines are removed
+- Functions whose name contains the substring “test” are removed
+- Constructors and standard extenion methods (eg `__str__` in Python or `toString` in Java) are removed
+- Duplicates and near duplicates functions are removed, in order to keep only one version of the function
+
+#### Who are the source language producers?
+
+OpenSource contributors produced the code and documentations.
+
+The dataset was gatherered and preprocessed automatically.
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+Each example in the dataset has is extracted from a GitHub repository, and each repository has its own license. Example-wise license information is not (yet) included in this dataset: you will need to find out yourself which license the code is using.
+
+### Citation Information
+
+@article{husain2019codesearchnet,
+  title={{CodeSearchNet} challenge: Evaluating the state of semantic code search},
+  author={Husain, Hamel and Wu, Ho-Hsiang and Gazit, Tiferet and Allamanis, Miltiadis and Brockschmidt, Marc},
+  journal={arXiv preprint arXiv:1909.09436},
+  year={2019}
+}
+
+### Contributions
+
+Thanks to [@SBrandeis](https://github.com/SBrandeis) for adding this dataset.

code_search_net.py

@@ -0,0 +1,218 @@
+# coding=utf-8
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Lint as: python3
+"""CodeSearchNet corpus: proxy dataset for semantic code search"""
+
+# TODO: add licensing info in the examples
+# TODO: log richer informations (especially while extracting the jsonl.gz files)
+# TODO: enable custom configs; such as: "java+python"
+# TODO: enable fetching examples with a given license, eg: "java_MIT"
+
+
+import json
+import os
+
+import datasets
+
+
+_CITATION = """\
+@article{husain2019codesearchnet,
+    title={{CodeSearchNet} challenge: Evaluating the state of semantic code search},
+    author={Husain, Hamel and Wu, Ho-Hsiang and Gazit, Tiferet and Allamanis, Miltiadis and Brockschmidt, Marc},
+    journal={arXiv preprint arXiv:1909.09436},
+    year={2019}
+}
+"""
+
+_DESCRIPTION = """\
+CodeSearchNet corpus contains about 6 million functions from open-source code \
+spanning six programming languages (Go, Java, JavaScript, PHP, Python, and Ruby). \
+The CodeSearchNet Corpus also contains automatically generated query-like \
+natural language for 2 million functions, obtained from mechanically scraping \
+and preprocessing associated function documentation.
+"""
+
+_HOMEPAGE = "https://github.com/github/CodeSearchNet"
+
+_LICENSE = "Various"
+
+_DATA_DIR_URL = "data/"
+_AVAILABLE_LANGUAGES = ["python", "java", "javascript", "go", "ruby", "php"]
+_URLs = {language: _DATA_DIR_URL + f"{language}.zip" for language in _AVAILABLE_LANGUAGES}
+# URLs for "all" are just the concatenation of URLs for all languages
+_URLs["all"] = _URLs.copy()
+
+
+class CodeSearchNet(datasets.GeneratorBasedBuilder):
+    """ "CodeSearchNet corpus: proxy dataset for semantic code search."""
+
+    VERSION = datasets.Version("1.0.0", "Add CodeSearchNet corpus dataset")
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(
+            name="all",
+            version=VERSION,
+            description="All available languages: Java, Go, Javascript, Python, PHP, Ruby",
+        ),
+        datasets.BuilderConfig(
+            name="java",
+            version=VERSION,
+            description="Java language",
+        ),
+        datasets.BuilderConfig(
+            name="go",
+            version=VERSION,
+            description="Go language",
+        ),
+        datasets.BuilderConfig(
+            name="python",
+            version=VERSION,
+            description="Pyhton language",
+        ),
+        datasets.BuilderConfig(
+            name="javascript",
+            version=VERSION,
+            description="Javascript language",
+        ),
+        datasets.BuilderConfig(
+            name="ruby",
+            version=VERSION,
+            description="Ruby language",
+        ),
+        datasets.BuilderConfig(
+            name="php",
+            version=VERSION,
+            description="PHP language",
+        ),
+    ]
+
+    DEFAULT_CONFIG_NAME = "all"
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "repository_name": datasets.Value("string"),
+                    "func_path_in_repository": datasets.Value("string"),
+                    "func_name": datasets.Value("string"),
+                    "whole_func_string": datasets.Value("string"),
+                    "language": datasets.Value("string"),
+                    "func_code_string": datasets.Value("string"),
+                    "func_code_tokens": datasets.Sequence(datasets.Value("string")),
+                    "func_documentation_string": datasets.Value("string"),
+                    "func_documentation_tokens": datasets.Sequence(datasets.Value("string")),
+                    "split_name": datasets.Value("string"),
+                    "func_code_url": datasets.Value("string"),
+                    # TODO - add licensing info in the examples
+                }
+            ),
+            # No default supervised keys
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators.
+
+        Note: The original data is stored in S3, and follows this unusual directory structure:
+            ```
+            .
+            ├── <language_name>  # e.g. python
+            │   └── final
+            │       └── jsonl
+            │ ��         ├── test
+            │           │   └── <language_name>_test_0.jsonl.gz
+            │           ├── train
+            │           │   ├── <language_name>_train_0.jsonl.gz
+            │           │   ├── <language_name>_train_1.jsonl.gz
+            │           │   ├── ...
+            │           │   └── <language_name>_train_n.jsonl.gz
+            │           └── valid
+            │               └── <language_name>_valid_0.jsonl.gz
+            ├── <language_name>_dedupe_definitions_v2.pkl
+            └── <language_name>_licenses.pkl
+            ```
+        """
+        data_urls = _URLs[self.config.name]
+        if isinstance(data_urls, str):
+            data_urls = {self.config.name: data_urls}
+        # Download & extract the language archives
+        data_dirs = [
+            os.path.join(directory, lang, "final", "jsonl")
+            for lang, directory in dl_manager.download_and_extract(data_urls).items()
+        ]
+
+        split2dirs = {
+            split_name: [os.path.join(directory, split_name) for directory in data_dirs]
+            for split_name in ["train", "test", "valid"]
+        }
+
+        split2paths = dl_manager.extract(
+            {
+                split_name: [
+                    os.path.join(directory, entry_name)
+                    for directory in split_dirs
+                    for entry_name in os.listdir(directory)
+                ]
+                for split_name, split_dirs in split2dirs.items()
+            }
+        )
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepaths": split2paths["train"],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "filepaths": split2paths["test"],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "filepaths": split2paths["valid"],
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepaths):
+        """Yields the examples by iterating through the available jsonl files."""
+        for file_id_, filepath in enumerate(filepaths):
+            with open(filepath, encoding="utf-8") as f:
+                for row_id_, row in enumerate(f):
+                    # Key of the example = file_id + row_id,
+                    # to ensure all examples have a distinct key
+                    id_ = f"{file_id_}_{row_id_}"
+                    data = json.loads(row)
+                    yield id_, {
+                        "repository_name": data["repo"],
+                        "func_path_in_repository": data["path"],
+                        "func_name": data["func_name"],
+                        "whole_func_string": data["original_string"],
+                        "language": data["language"],
+                        "func_code_string": data["code"],
+                        "func_code_tokens": data["code_tokens"],
+                        "func_documentation_string": data["docstring"],
+                        "func_documentation_tokens": data["docstring_tokens"],
+                        "split_name": data["partition"],
+                        "func_code_url": data["url"],
+                    }

data/go.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:15d23f01dc2796447e1736263e6830079289d5ef41f09988011afdcf8da6b6e5
+size 487525935

data/java.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:05f9204b1808413fab30f0e69229e298f6de4ad468279d53a2aa5797e3a78c17
+size 1060569153

data/javascript.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fdc743f5af27f90c77584a2d29e2b7f8cecdd00c37b433c385b888ee062936dd
+size 1664713350

data/php.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c3bbf0d1b10010f88b058faea876f1f5471758399e30d58c11f78ff53660ce00
+size 851894048

data/python.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7223c6460bebfa85697b586da91e47bc5d64790a4d60bba5917106458ab6b40e
+size 940909997

data/ruby.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:67aee5812d0f994df745c771c7791483f2b060561495747d424e307af4b342e6
+size 111758028