Update README.md

README.md

@@ -43,69 +43,101 @@ pretty_name: Beverage Energy Tracker
 size_categories:
 - 10K<n<100K
 ---
+# Dataset Card for Beverage Energy Tracker
 
-# Model Card - Beverage Energy Tracker Dataset
-
-##  Purpose
-This dataset was created to analyze and model the energy related characteristics of common beverages based on measurable features. It is intended for educational and experimental machine learning use cases, such as binary classification and feature importance analysis.
-
-## Composition
-The dataset contains:
-- 30 manually collected real world samples in the `original` split
-- 300 label preserving synthetic samples in the `augmented` split  
-Each sample includes:
-- 5 input features (category, Added sugar(g), Calories, Volume, Energy rating)
-- 1 binary target variable indicating the sugar level (is high sugar?)
-
-## Collection
-Data was manually gathered from the product description pages of:
-- Starbucks  
-- ALDI USA  
-- MarketDistrict  
-- Amazon  
-- Walmart  
-
-Feature values such as sugar content, calories, volume and category were noted for each drink. Energy rating collected from consumers (Friends). The binary target (`is_high_sugar?`) was assigned based on sugar content (0 if <20g).
-
-## Preprocessing & Augmentation
-- Basic preprocessing: cleaned column names, ensured numerical features were floats/integers.
-- For augmentation, **label preserving jitter techniques** were used:
-  - Gaussian noise was added to continuous features (`Added sugar (g)`, `Calories`).
-  - ±1 encoding step changes applied to the integer feature (`Energy rating`), clipped to valid bounds (1-5).
-- Categorical fields (`Beverage type`, `Volume`) were left unchanged to preserve label consistency.
-- This process expanded the dataset to 300 augmented samples.
-
-
-## Labels
-- **Features:**
-  - `Beverage type` (categorical, string)
-  - `Added sugar (g)` (float)
-  - `Calories` (float)
-  - `Volume` (categorical, 300 mL or 355 mL)
-  - `Energy rating` (int, 1–5)
-- **Target:**  
-  - `is high sugar?` – integer label, also used for prediction tasks
-
-## Splits
-- `original`: 30 real world examples
-- `augmented`: 300 synthetic samples via jitter based augmentation
-
-## Intended Use / Limitations
-- **Use cases:** regression/classification practice, feature importance exploration, interpretable ML projects
-- **Limitations:** small original sample size, subjective energy rating label, dataset not exhaustive of all beverage categories
-
-This dataset is **not** intended for nutrition advice or commercial recommendation engines.
-
-## Ethical Notes
-- No personally identifiable information is included.
-- Energy ratings are subjective and approximate.
-- Consumers should not use this data for health or fitness decisions.
-
-## License
-This dataset is released under the **Creative Commons Attribution 4.0 International (CC BY 4.0)** license.
-
-## AI Usage Disclosure
-ChatGPT (GPT-4) was used as a **teammate throughout the process** to assist with:
-- On the go Python coding
-- Augmentation approach
-- Polishing and formatting the final dataset and notebook
+This dataset card documents the **Beverage Energy Tracker** dataset.  
+It contains nutritional and energy-related features of 30 unique beverages, with an augmented split expanding to 300+ rows.  
+
+---
+
+## Dataset Details
+
+**Dataset Description**  
+- **Curated by:** Bareethul Kader (Carnegie Mellon University, EST&P program)  
+- **Language(s):** English (column labels, beverage names)  
+- **License:** CC BY 4.0  
+- **Repository:** [bareethul/beverage-energy-tracker](https://huggingface.co/datasets/bareethul/beverage-energy-tracker)  
+
+---
+
+## Uses
+
+**Direct Use**  
+- Educational practice in data collection, preprocessing, and augmentation.  
+- Demonstration of label-preserving jitter augmentation for tabular datasets.  
+
+**Out-of-Scope Use**  
+- Not intended for clinical, nutritional, or health policy decision-making.  
+- Values are approximate and curated manually — not to be used for dietary guidance.  
+
+---
+
+## Dataset Structure
+
+- **Original split:** 30 manually curated beverages.  
+- **Augmented split:** 300 rows, generated with Gaussian jitter (for continuous features) and ±1 step encoding (for ordinal features).  
+
+**Features:**  
+- `Beverage type` (string)  
+- `Added sugar (g)` (float)  
+- `Calories` (float)  
+- `Volume (mL)` (integer)  
+- `Energy rating (1–5)` (ordinal target label)  
+
+---
+
+## Dataset Creation
+
+**Curation Rationale**  
+To study how nutritional features (sugar, calories, volume) can relate to an *energy rating*.  
+
+**Data Collection and Processing**  
+- Data manually collected from: Starbucks, ALDI USA, MarketDistrict, Amazon, Walmart product pages.  
+- Manual preprocessing and type formatting were applied (e.g., ensuring numeric columns, clipping noise to avoid negative values).  
+
+**Source Data Producers**  
+- Original producers: beverage manufacturers and retailers (nutritional info posted publicly).  
+- Dataset curated by Bareethul Kader for educational purposes.  
+
+---
+
+## Annotations
+
+- **Annotation Process:** Energy rating was assigned manually (scale 1–5).  
+- **Annotators:** Dataset creator.  
+
+---
+
+## Personal and Sensitive Information
+
+- No personal or sensitive data included.  
+
+---
+
+## Bias, Risks, and Limitations
+
+- Limited to 30 beverages (not representative of all products).  
+- Energy rating is subjective, not an industry standard.  
+- Augmentation may create unrealistic numeric combinations.  
+
+---
+
+## Recommendations
+
+Users should be aware of the risks, biases, and limitations of the dataset.  
+It is intended only for **educational demonstrations** of dataset creation, preprocessing, and augmentation.  
+Do not generalize results to real nutrition/health applications.  
+
+---
+
+## Citation
+
+**BibTeX:**  
+```bibtex
+@dataset{bareethul_beverage_energy_tracker,
+  author       = {Kader, Bareethul},
+  title        = {Beverage Energy Tracker},
+  year         = {2025},
+  publisher    = {Hugging Face Datasets},
+  url          = {https://huggingface.co/datasets/bareethul/beverage-energy-tracker}
+}