Upload README.md

README.md

@@ -8,66 +8,26 @@ language:
 size_categories:
 - 1K<n<10K
 dataset_info:
-- config_name: all
+- config_name: cpp
   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
+    num_bytes: 0
+    num_examples: 3000
   - name: test
-    num_bytes: 308626333
-    num_examples: 100529
+    num_bytes: 0
+    num_examples: 100
   - name: validation
-    num_bytes: 274564382
-    num_examples: 89154
-  download_size: 5117370511
-  dataset_size: 6433794798
+    num_bytes: 0
+    num_examples: 1000
+  download_size: 0
+  dataset_size: 0
 - config_name: cpp
   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
@@ -115,48 +75,29 @@ A data point consists of a function code along with its documentation. Each data
 ```
 {
   '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'
+  'func_code_string': 'organisation/repository'
 }
 ```
 
 ### 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
+- `func_code_string`: actual code line (each line is a whole C++ program)
 
 ### Data Splits
 
-Three splits are available:
-- train
-- test
-- valid
+Three splits are available as `.jsonl`:
+- train (3000 lines)
+- test (100 lines)
+- valid (1000 lines)
 
 ### Citation Information
 
-- based on (format and idea): https://huggingface.co/datasets/code_search_net/blob/main/code_search_net.py
-
+- based on this dataset source: https://huggingface.co/datasets/nguyentruong-ins/codeforces_cpp_cleaned/tree/main/data
+- based on format and idea: https://huggingface.co/datasets/code_search_net
+- expanded by
 @article{husain2019codesearchnet,
   title={C++ Dataset},
   author={Klaes, Malte},
   year={2024}
-}
+}