jensinjames commited on
Commit
01b263b
1 Parent(s): a3d16b3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +99 -3
README.md CHANGED
@@ -1,3 +1,99 @@
1
- ---
2
- license: cc-by-4.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-4.0
3
+ task_categories:
4
+ - feature-extraction
5
+ - fill-mask
6
+ language:
7
+ - en
8
+ ---
9
+ # Dataset Card for MAD_data
10
+
11
+ This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
12
+
13
+ ## Dataset Details
14
+
15
+ ### Dataset Description
16
+
17
+ MAD_data consists of various Manim scripts and their corresponding rendered animations. The scripts demonstrate a range of animations, transformations, and visual effects using the Manim library. This dataset is intended to help train machine learning models in generating and understanding Manim animations.
18
+
19
+ - **Curated by:** Jensin
20
+ - **Funded by [optional]:** [More Information Needed]
21
+ - **Shared by [optional]:** [More Information Needed]
22
+ - **Language(s) (NLP):** English
23
+ - **License:** cc-by-4.0
24
+
25
+ ### Dataset Sources [optional]
26
+
27
+ - **Repository:** [More Information Needed]
28
+ - **Paper [optional]:** [More Information Needed]
29
+ - **Demo [optional]:** [More Information Needed]
30
+
31
+ ## Uses
32
+
33
+ ### Direct Use
34
+
35
+ This dataset can be used for training models to generate Manim scripts based on textual descriptions, to understand the structure of Manim scripts, and to create new animations programmatically.
36
+
37
+ ### Out-of-Scope Use
38
+
39
+ This dataset is not intended for applications unrelated to animation generation, such as general NLP tasks not involving script or animation understanding.
40
+
41
+ ## Dataset Structure
42
+
43
+ Each entry in the dataset includes:
44
+ - The name of the animation.
45
+ - A description of the animation.
46
+ - The Manim script used to generate the animation.
47
+ - Key concepts demonstrated by the animation.
48
+ - Creative aspects of the animation.
49
+ - The path to the rendered animation file.
50
+
51
+ ## Dataset Creation
52
+
53
+ ### Curation Rationale
54
+
55
+ The dataset was created to provide a comprehensive collection of Manim scripts and animations to facilitate research and development in the field of automated animation generation and understanding.
56
+
57
+ ### Source Data
58
+
59
+ #### Data Collection and Processing
60
+
61
+ The data was collected from existing Manim scripts available in the public domain and additional custom scripts created to cover a wide range of animation techniques and styles. Each script was rendered using Manim to generate the corresponding animation.
62
+
63
+ #### Who are the source data producers?
64
+
65
+ The source data was produced by Jensin and contributions from the Manim community.
66
+
67
+ ### Annotations [optional]
68
+
69
+ #### Annotation process
70
+
71
+ Annotations include descriptions, key concepts, and creative aspects for each animation. These annotations were provided by Jensin based on the content and purpose of each script.
72
+
73
+ #### Who are the annotators?
74
+
75
+ Annotations were provided by Jensin.
76
+
77
+ #### Personal and Sensitive Information
78
+
79
+ The dataset does not contain any personal, sensitive, or private information.
80
+
81
+ ## Bias, Risks, and Limitations
82
+
83
+ This dataset is focused on Manim animations and may not generalize well to other types of animations or scripting languages. The scripts and animations included are intended for educational and research purposes.
84
+
85
+ ### Recommendations
86
+
87
+ Users should be aware of the limitations of the dataset, particularly its focus on Manim-specific animations. Care should be taken to ensure that any derived models are used appropriately and within the scope of their intended application.
88
+
89
+ ## Citation [optional]
90
+
91
+ **BibTeX:**
92
+
93
+ [More Information Needed]
94
+
95
+ Jensin
96
+
97
+ ## Dataset Card Contact
98
+
99
+ Jensin