Update README.md

README.md

@@ -1,26 +1,76 @@
 ---
-dataset_info:
-  features:
-  - name: School
-    dtype: string
-  - name: Hall/Location
-    dtype: string
-  - name: Text
-    dtype: string
-  splits:
-  - name: original
-    num_bytes: 24706
-    num_examples: 100
-  - name: augmented
-    num_bytes: 248304
-    num_examples: 1000
-  download_size: 103651
-  dataset_size: 273010
-configs:
-- config_name: default
-  data_files:
-  - split: original
-    path: data/original-*
-  - split: augmented
-    path: data/augmented-*
+license: mit
+language:
+- en
+pretty_name: HW1 Text Dataset
 ---
+
+
+# Dataset Card for {{ pretty_name | default("Dataset Name", true) }}
+
+This dataset covers 1000 locations at 5 universities with descriptions and reviews of locations
+based on my personal experience. 
+
+## Dataset Details
+
+### Dataset Description
+
+- **Curated by:** Carnegie Mellon University: 24-679
+- **Shared by [optional]:** Devin DeCosmo
+- **Language(s) (NLP):** English
+- **License:** MIT
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** {{ repo | default("[More Information Needed]", true)}}
+
+
+## Uses
+
+The main use was to train text models to predict the specific university or location based on the personal text description. 
+
+### Direct Use
+
+The direct use would be analysis tasks to predict the location based off the text.
+
+### Out-of-Scope Use
+
+Could be used for sentiment analysis and similar tasks. 
+
+
+## Dataset Structure
+
+This dataset consists of two splits
+An original split with 100 rows
+An artificial split with 1000 rows
+
+The tasks fall into 4 categories based on the university
+1. CMU
+2. ASU
+3. Bucknell
+4. Duquesne
+5. UCSD
+
+## Dataset Creation
+
+### Source Data
+
+Source data is personal statements and reviews from the owner. 
+
+#### Data Collection and Processing
+
+Data was written by the creator of this dataset. 
+
+#### Who are the source data producers?
+
+Data was initially produced by the owner. 
+
+## Bias, Risks, and Limitations
+
+This is a very small data set and will likely have issues with training and fitting, especially for more complex analysis. 
+
+### Recommendations
+
+This dataset probably has limited accuracy as a first draft but may be useful for learning how to train models.