Update README.md

README.md

@@ -1,373 +1,25 @@
+license: mit
+language:
+- en
+tags:
+- github-issues
+- data-science
 ---
-dataset_info:
-  features:
-  - name: url
-    dtype: string
-  - name: repository_url
-    dtype: string
-  - name: labels_url
-    dtype: string
-  - name: comments_url
-    dtype: string
-  - name: events_url
-    dtype: string
-  - name: html_url
-    dtype: string
-  - name: id
-    dtype: int64
-  - name: node_id
-    dtype: string
-  - name: number
-    dtype: int64
-  - name: title
-    dtype: string
-  - name: user
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: labels
-    list:
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: name
-      dtype: string
-    - name: color
-      dtype: string
-    - name: default
-      dtype: bool
-    - name: description
-      dtype: string
-    - name: archived_at
-      dtype: 'null'
-    - name: archived_by
-      dtype: 'null'
-  - name: state
-    dtype: string
-  - name: locked
-    dtype: bool
-  - name: assignees
-    list:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: milestone
-    struct:
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: labels_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: number
-      dtype: int64
-    - name: title
-      dtype: string
-    - name: description
-      dtype: string
-    - name: creator
-      struct:
-      - name: login
-        dtype: string
-      - name: id
-        dtype: int64
-      - name: node_id
-        dtype: string
-      - name: avatar_url
-        dtype: string
-      - name: gravatar_id
-        dtype: string
-      - name: url
-        dtype: string
-      - name: html_url
-        dtype: string
-      - name: followers_url
-        dtype: string
-      - name: following_url
-        dtype: string
-      - name: gists_url
-        dtype: string
-      - name: starred_url
-        dtype: string
-      - name: subscriptions_url
-        dtype: string
-      - name: organizations_url
-        dtype: string
-      - name: repos_url
-        dtype: string
-      - name: events_url
-        dtype: string
-      - name: received_events_url
-        dtype: string
-      - name: type
-        dtype: string
-      - name: user_view_type
-        dtype: string
-      - name: site_admin
-        dtype: bool
-    - name: open_issues
-      dtype: int64
-    - name: closed_issues
-      dtype: int64
-    - name: state
-      dtype: string
-    - name: created_at
-      dtype: timestamp[s]
-    - name: updated_at
-      dtype: timestamp[s]
-    - name: due_on
-      dtype: 'null'
-    - name: closed_at
-      dtype: 'null'
-  - name: comments
-    dtype: int64
-  - name: created_at
-    dtype: timestamp[s]
-  - name: updated_at
-    dtype: timestamp[s]
-  - name: closed_at
-    dtype: timestamp[s]
-  - name: assignee
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: author_association
-    dtype: string
-  - name: issue_field_values
-    sequence: 'null'
-  - name: type
-    dtype: 'null'
-  - name: active_lock_reason
-    dtype: 'null'
-  - name: draft
-    dtype: bool
-  - name: pull_request
-    struct:
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: diff_url
-      dtype: string
-    - name: patch_url
-      dtype: string
-    - name: merged_at
-      dtype: timestamp[s]
-  - name: body
-    dtype: string
-  - name: closed_by
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: reactions
-    struct:
-    - name: url
-      dtype: string
-    - name: total_count
-      dtype: int64
-    - name: '+1'
-      dtype: int64
-    - name: '-1'
-      dtype: int64
-    - name: laugh
-      dtype: int64
-    - name: hooray
-      dtype: int64
-    - name: confused
-      dtype: int64
-    - name: heart
-      dtype: int64
-    - name: rocket
-      dtype: int64
-    - name: eyes
-      dtype: int64
-  - name: timeline_url
-    dtype: string
-  - name: performed_via_github_app
-    dtype: 'null'
-  - name: state_reason
-    dtype: string
-  - name: sub_issues_summary
-    struct:
-    - name: total
-      dtype: int64
-    - name: completed
-      dtype: int64
-    - name: percent_completed
-      dtype: int64
-  - name: issue_dependencies_summary
-    struct:
-    - name: blocked_by
-      dtype: int64
-    - name: total_blocked_by
-      dtype: int64
-    - name: blocking
-      dtype: int64
-    - name: total_blocking
-      dtype: int64
-  - name: pinned_comment
-    dtype: 'null'
-  - name: is_pull_request
-    dtype: bool
-  splits:
-  - name: train
-    num_bytes: 19553727
-    num_examples: 5000
-  download_size: 4536055
-  dataset_size: 19553727
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+
+# GitHub Issues Dataset
+
+## Overview
+This dataset contains 5,000 GitHub issues used for data science analysing, transformer pipelines, and semantic search with FAISS
+
+## Data Source
+* Extracted from public GitHub repositories/APIs.
+* Focuses on issue titles and descriptions for natural language processing tasks.
+
+## Cleaning & Preparation
+* Checked and handled missing values across data columns.
+* Verified unique issue IDs to check for duplicates.
+* Cleaned and formatted into a Pandas DataFrame.
+
+## Ethics & Compliance
+* Contains only public, open-source data.
+* Free from private information, passwords, or personal data (PII).