updated class name and documentation

Shellcode_IA32.py

@@ -25,18 +25,30 @@ import datasets
 # TODO: Add BibTeX citation
 # Find for instance the citation on arxiv or on the dataset repo/website
 _CITATION = """\
-@InProceedings{huggingface:dataset,
-title = {A great new dataset},
-author={huggingface, Inc.
-},
-year={2020}
+    @inproceedings{liguori-etal-2021-shellcode,
+    title = "{S}hellcode{\_}{IA}32: A Dataset for Automatic Shellcode Generation",
+    author = "Liguori, Pietro  and
+      Al-Hossami, Erfan  and
+      Cotroneo, Domenico  and
+      Natella, Roberto  and
+      Cukic, Bojan  and
+      Shaikh, Samira",
+    booktitle = "Proceedings of the 1st Workshop on Natural Language Processing for Programming (NLP4Prog 2021)",
+    month = aug,
+    year = "2021",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.nlp4prog-1.7",
+    doi = "10.18653/v1/2021.nlp4prog-1.7",
+    pages = "58--64",
+    abstract = "We take the first step to address the task of automatically generating shellcodes, i.e., small pieces of code used as a payload in the exploitation of a software vulnerability, starting from natural language comments. We assemble and release a novel dataset (Shellcode{\_}IA32), consisting of challenging but common assembly instructions with their natural language descriptions. We experiment with standard methods in neural machine translation (NMT) to establish baseline performance levels on this task.",
 }
 """
 
 # TODO: Add description of the dataset here
 # You can copy an official description
 _DESCRIPTION = """\
-This new dataset is designed to solve this great NLP task and is crafted with a lot of care.
+Shellcode_IA32 is a dataset for shellcode generation from English intents. The shellcodes are compilable on Intel Architecture 32-bits.
 """
 
 # TODO: Add a link to an official homepage for the dataset here
@@ -54,7 +66,7 @@ _URLs = {
 
 
 # TODO: Name of the dataset usually match the script name with CamelCase instead of snake_case
-class Shellcode_IA32(datasets.GeneratorBasedBuilder):
+class ShellcodeIA32(datasets.GeneratorBasedBuilder):
     """Shellcode_IA32 a dataset for shellcode generation"""
 
     VERSION = datasets.Version("1.1.0")
@@ -70,10 +82,10 @@ class Shellcode_IA32(datasets.GeneratorBasedBuilder):
     # You will be able to load one or the other configurations in the following list with
     # data = datasets.load_dataset('my_dataset', 'first_domain')
     # data = datasets.load_dataset('my_dataset', 'second_domain')
-    BUILDER_CONFIGS = [
-        datasets.BuilderConfig(name="default", version=VERSION, description="This part of my dataset covers the default train/test split"),
-        #datasets.BuilderConfig(name="second_domain", version=VERSION, description="This part of my dataset covers a second domain"),
-    ]
+    # BUILDER_CONFIGS = [
+    #     datasets.BuilderConfig(name="default", version=VERSION, description="This part of my dataset covers the default train/test split"),
+    #     #datasets.BuilderConfig(name="second_domain", version=VERSION, description="This part of my dataset covers a second domain"),
+    # ]
 
     DEFAULT_CONFIG_NAME = "default"  # It's not mandatory to have a default configuration. Just use one if it make sense.