Update README.md

README.md

@@ -32,4 +32,146 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: cc-by-nc-nd-4.0
+task_categories:
+- text-classification
+language:
+- en
+tags:
+- finance
+- news
+- NLP
+- Multiclass Classification
+size_categories:
+- 10K<n<100K
 ---
+# Dataset Card for Dataset Name
+
+<!-- Provide a quick summary of the dataset. -->
+
+This is a news dataset for the commodity market which has been manually annotated 10,000+ news headlines across multiple dimensions into various classes. The dataset has been sampled from a period of 20+ years (2000-2021).
+The dataset was curated by Ankur Sinha and Tanmay Khandait and is detailed in their paper "Impact of News on the Commodity Market: Dataset and Results." It is currently published by the authors on Kaggle, under the Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0) license.
+
+Sinha, Ankur, and Tanmay Khandait. "Impact of News on the Commodity Market: Dataset and Results." In Future of Information and Communication Conference, pp. 589-601. Springer, Cham, 2021.
+
+## Dataset Description
+- **Homepage:** [Kaggle](https://www.kaggle.com/ankurzing/sentiment-analysis-for-financial-news) [ResearchGate](https://www.researchgate.net/publication/350914989_Impact_of_News_on_the_Commodity_Market_Dataset_and_Results)
+- **Repository:**
+- **Paper:** [Arxiv](https://arxiv.org/abs/2009.04202)
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+Sentiment Classification
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+### Data Instances
+```
+{
+  'Dates': '28-01-2016',
+  'URL': 'http://www.marketwatch.com/story/april-gold-down-20-cents-to-settle-at-111610oz-2016-01-28',
+  'News': 'april gold down 20 cents to settle at $1,116.10/oz',
+  'Price Direction Up': 0, 'Price Direction Constant': 0,
+  'Price Direction Down': 1,
+  'Asset Comparision': 0,
+  'Past Information': 1,
+  'Future Information': 0,
+  'Price Sentiment': 'negative'
+}
+```
+
+### Data Fields
+- Dates: Date of news headline
+- URL: URL of news headline
+- News: News headline
+- Price Direction Up: Does the news headline imply price direction up?
+- Price Direction Constant: Does the news headline imply price direction sideways (no change)?
+- Price Direction Down: Does the news headline imply price direction down?
+- Asset Comparision: Are assets being compared?
+- Past Information: Is the news headline talking about past?
+- Future Information: Is the news headline talking about future?
+- Price Sentiment: Price sentiment of Gold commodity based on headline
+
+### Data Splits
+There's no train/validation/test split.
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+"Commodity prices are known to be quite volatile. Machine learning models that understand the commodity news well, will be able to provide an additional input to the short-term and long-term price forecasting models. The dataset will also be useful in creating news-based indicators for commodities.
+
+Apart from researchers and practitioners working in the area of news analytics for commodities, the dataset will also be useful for researchers looking to evaluate their models on classification problems in the context of text-analytics. Some of the classes in the dataset are highly imbalanced and may pose challenges to the machine learning algorithms."
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+The source data is news text and headlines.
+
+#### Data Collection and Processing
+"The dataset has been collected from various news sources and annotated by three human annotators who were subject experts. Each news headline was evaluated on various dimensions, for instance - if a headline is a price related news then what is the direction of price movements it is talking about; whether the news headline is talking about the past or future; whether the news item is talking about asset comparison; etc."
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+<!-- #### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+<!-- 
+[More Information Needed]
+
+#### Who are the annotators? -->
+
+<!-- This section describes the people or systems who created the annotations. -->
+<!-- 
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+<!-- [More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+<!-- [More Information Needed] -->
+
+<!-- ### Recommendations -->
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+<!-- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. --> 
+
+## Citation
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+```
+[@misc{sinha2020impactnewscommoditymarket,
+      title={Impact of News on the Commodity Market: Dataset and Results}, 
+      author={Ankur Sinha and Tanmay Khandait},
+      year={2020},
+      eprint={2009.04202},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2009.04202}, 
+}]
+```
+
+<!-- ## Glossary [optional]
+ -->
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+<!-- [More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed] -->
+
+## Dataset Card Authors
+Saguaro Capital Management, LLC
+
+## Dataset Card Contact
+[https://www.saguarocm.com/](https://www.saguarocm.com/)