Create README.md

README.md

@@ -0,0 +1,36 @@
+---
+task_categories:
+- text-classification
+- text2text-generation
+- summarization
+language:
+- en
+---
+
+# typescript-chunks
+A processed version of the typescript subset from [the-stack-smol](https://huggingface.co/datasets/bigcode/the-stack-smol). 
+
+Each source file is parsed with the TypeScript AST and split into 'semantic chunks'. Then, each chunk is traversed to gather comments.
+
+Types:
+- FunctionDeclaration
+- ArrowFunction
+- ClassDeclaration
+- InterfaceDeclaration
+- EnumDeclaration
+- TypeAliasDeclaration
+- MethodDeclaration
+- ModuleDeclaration
+
+# Dataset Structure
+```python
+from datasets import load_dataset
+load_dataset("bleugreen/typescript-chunks")
+
+DatasetDict({
+    train: Dataset({
+        features: ['repo', 'path', 'language', 'content', 'comments'],
+        num_rows: 300000
+    })
+})
+```