Add task category, link paper, and fix usage snippet

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +12 -17
README.md CHANGED
@@ -46,15 +46,20 @@ configs:
46
  path: data/validation-*
47
  - split: test
48
  path: data/test-*
 
 
 
 
49
  ---
50
 
 
51
 
52
- # ArkTS Function Dataset
53
-
54
- **Dataset Hub:** [hreyulog/arkts-code-docstring](https://huggingface.co/datasets/hreyulog/arkts-code-docstring/)
55
 
56
  This dataset collects **function-level information from ArkTS (HarmonyOS Ark TypeScript) projects**, including original functions, docstrings, abstract syntax tree (AST) representations, obfuscated versions, and source code metadata. It is suitable for tasks such as code analysis, code understanding, AST research, and code search.
57
 
 
 
58
  ## Dataset Structure
59
 
60
  The dataset contains three splits:
@@ -88,7 +93,7 @@ Each split is a **JSON Lines (.jsonl) file**, where each line is a JSON object r
88
  from datasets import load_dataset
89
 
90
  # Load the dataset
91
- dataset = load_dataset("USERNAME/DATASET_NAME")
92
 
93
  # Inspect the first training example
94
  print(dataset["train"][0])
@@ -96,21 +101,10 @@ print(dataset["train"][0])
96
  # Check dataset features
97
  print(dataset["train"].features)
98
  ```
99
- ## Evaluation
100
-
101
- [hreyulog/retrieval_eval](https://github.com/hreyulog/retrieval_eval)
102
-
103
- ## Fine-Tuned Model
104
-
105
- We provide a SentenceTransformer model fine-tuned on this dataset:
106
-
107
- [hreyulog/embedinggemma_arkts](https://huggingface.co/hreyulog/embedinggemma_arkts)
108
-
109
-
110
 
111
- ## Citation / Preprint
112
 
113
- If you use this dataset in your research, please cite the following preprint:
114
 
115
  ```bibtex
116
  @misc{he2026arktscodesearchopensourcearktsdataset,
@@ -122,3 +116,4 @@ If you use this dataset in your research, please cite the following preprint:
122
  primaryClass={cs.SE},
123
  url={https://arxiv.org/abs/2602.05550},
124
  }
 
 
46
  path: data/validation-*
47
  - split: test
48
  path: data/test-*
49
+ task_categories:
50
+ - text-retrieval
51
+ language:
52
+ - en
53
  ---
54
 
55
+ # ArkTS-CodeSearch: A Open-Source ArkTS Dataset for Code Retrieval
56
 
57
+ [Paper](https://huggingface.co/papers/2602.05550) | [Evaluation Code](https://github.com/hreyulog/retrieval_eval) | [Fine-Tuned Model](https://huggingface.co/hreyulog/embedinggemma_arkts)
 
 
58
 
59
  This dataset collects **function-level information from ArkTS (HarmonyOS Ark TypeScript) projects**, including original functions, docstrings, abstract syntax tree (AST) representations, obfuscated versions, and source code metadata. It is suitable for tasks such as code analysis, code understanding, AST research, and code search.
60
 
61
+ ArkTS is a core programming language in the OpenHarmony ecosystem. This dataset was constructed from open-source repositories crawled from GitHub and Gitee, targeting code retrieval and code evaluation tasks.
62
+
63
  ## Dataset Structure
64
 
65
  The dataset contains three splits:
 
93
  from datasets import load_dataset
94
 
95
  # Load the dataset
96
+ dataset = load_dataset("hreyulog/arkts-code-docstring")
97
 
98
  # Inspect the first training example
99
  print(dataset["train"][0])
 
101
  # Check dataset features
102
  print(dataset["train"].features)
103
  ```
 
 
 
 
 
 
 
 
 
 
 
104
 
105
+ ## Citation
106
 
107
+ If you use this dataset in your research, please cite the following paper:
108
 
109
  ```bibtex
110
  @misc{he2026arktscodesearchopensourcearktsdataset,
 
116
  primaryClass={cs.SE},
117
  url={https://arxiv.org/abs/2602.05550},
118
  }
119
+ ```