Update README.md

README.md

@@ -1,3 +1,129 @@
----
-license: apache-2.0
----
+---
+annotations_creators:
+- machine. Although we scrapped web-sites and collected tags placed by the articles authors, whether they had been labeled by human or machine stays unknown
+language_creators:
+- found
+language:
+- ru
+license: apache-2.0
+multilinguality:
+- monolingual
+size_categories:
+- 100K<n<1M
+source_datasets:
+- original
+task_categories:
+- text-classification
+- text-generation
+- summarization
+- time-series-forecasting
+- tabular-regression
+task_ids:
+- keyword-extraction
+- sentiment-analysis
+- summarization
+- sentiment-scoring
+- time-series-forecasting
+---
+
+# RussianFinancialNews
+
+Датасет содержит 92,377 русскоязычных новостных статей на финансовую тематику, преимущественно про российский рынок ценных бумаг и российскую экономику. Набор данных может быть полезен для разных задач обработки естественного языка (NLP). 
+
+A dataset containing 92,377 samples of Russian financial news articles. Each sample includes metadata and content fields that are useful for various Natural Language Processing (NLP) tasks.
+
+## Dataset Summary
+
+RussianFinancialNews - коллекция новостных статей, опубликованных на сайтах федеральных российских СМИ, финансовых компаний, телеграм каналах: Финам, РБК, БКС ЭКСПРЕСС, РДВ, Т-Инвестиции, Т-Инвестиции-Аналитика. Датасет спроектирован для применения в задачах оценки тональности, извлечения ключевых слов. Датасет богат метаданными, включая дату и время публикации, что может быть полезно для применения в задачах прогнозирования финансовых временных рядов и построения алгоритмических торговых стратегий с применением мультимодальных подходов.
+
+RussianFinancialNews is a collection of financial news articles published on Russian websites of federal Media and Financial Companies: Finam, RBC, BCS Express, RDV, T-Invest, T-Invest-Analytics. It is designed to facilitate tasks such as sentiment analysis, text summarization, and keyword extraction in the financial domain. The dataset is rich in metadata, including publication date and time, which one might find beneficial for financial time-serias forecasting and algotrading strategies designing based on multimodality.
+
+## Supported Tasks and Leaderboards
+
+Данный набор данных поддерживает:
+- **Анализ тональности (Sentiment Analysis)**: Оценка тональности финансовых новостей.
+- **Суммаризация текста (Text Summarization)**: Генерация кратких резюме финансовых новостей.
+- **Извлечение ключевых слов (Keyword Extraction)**: Выделение релевантных ключевых слов или тикеров из текста новостей.
+- **Адаптация к домену (Domain Adaptation)**: Обучение моделей, специализированных на финансовых текстах.
+
+
+This dataset supports:
+- **Sentiment Analysis**: Assess the sentiment of financial news articles.
+- **Text Summarization**: Generate concise summaries of financial news articles.
+- **Keyword Extraction**: Identify relevant keywords or tickers in the news.
+- **Domain Adaptation**: Train models specialized in financial text.
+
+## Languages
+
+Датасет преимущественно на русском.
+
+Аннотированные статьи с помощью моделей ChatGPT4o и LLama3:8b содержат размышления на английском.
+
+The dataset is entirely in Russian (`ru`).
+
+## Dataset Structure
+
+### Поля данных:
+- **title**: Заголовок новости (строка).  
+- **body**: Основной текст новости (строка).  
+- **date**: Дата публикации (строка, формат: YYYY-MM-DD).  
+- **time**: Время публикации (строка, формат: HH:MM).  
+- **tags**: Ключевые слова или тикеры, связанные с новостью (список строк).  
+- **source**: Источник новости (строка, одно из значений: rdv, bcs, finam, rbc, t-invest).  
+
+### Разделение данных:
+В данный момент набор данных не содержит заранее определённых разбиений. Пользователи могут создавать собственные разбиения в зависимости от решаемых задач.  
+
+### Источники данных:
+Данные были собраны путём парсинга финансовых новостей с следующих российских сайтов и Telegram-каналов:
+
+- **RDV** — Telegram-канал.  
+- **BCS Express** — сайт компании BCS, представленный с двумя тегами источников: `bcs` и `bcs_tech`.  
+- **Finam** — сайт компании Finam.  
+- **RBC** — федеральное медиа.  
+- **T-Invest** — Telegram-канал российского банка Т-Банк, представленный с двумя тегами: `t-invest` и `t-analytic`.  
+
+Data Fields:
+- **title**: The title of the news article (string).
+- **body**: The main text of the news article (string).
+- **date**: The publication date (string, format: YYYY-MM-DD).
+- **time**: The publication time (string, format: HH:MM).
+- **tags**: Keywords or tickers associated with the article (list of strings).
+- **source**: The originating website (string, one of rdv, bcs, finam, rbc, t-invest).
+
+Data Splits:
+Currently, the dataset does not include predefined splits. Users can create their own splits based on their tasks.
+
+
+The dataset was collected by scraping financial news from the following Russian websites / telegram-channels:
+
+- **RDV** - a telegram channel
+- **BCS Express** - a website of BCS - presented with two source tags: 'bcs' and 'bcs_tech'
+- **Finam** - a website of Finam
+- **RBC** - federal media
+- **T-Invest** - telegram channel of Russian Bank T-Bank, presented with two tags: 't-invest' and 't-analytic'
+
+
+### Data Instances
+
+A typical instance in JSON format:
+```json
+{
+  "title": "Цены на нефть выросли",
+  "body": "Цены на нефть марки Brent выросли на 2% после заявления ОПЕК.",
+  "date": "2023-07-12",
+  "time": "15:32",
+  "tags": ["Brent", "ОПЕК", "нефть"],
+  "source": "rbc"
+}
+
+
+## Citation Information:
+
+@dataset{russian_financial_news_2024,
+  title={RussianFinancialNews},
+  author={Kasymkhan K.},
+  year={2024},
+  note={https://huggingface.co/datasets/Kasymkhan/RussianFinancialNews}
+}
+