Update README.md

README.md

@@ -1,18 +1,374 @@
 ---
+language:
+- en
+license: mit
+tags:
+- github
+- issues
+- machine-learning
+- nlp
+task_categories:
+- text-classification
+pretty_name: GitHub Issues Augmented Dataset
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
 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: body
+  - 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: 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: comments_text
+  - 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: state
+  - name: issue_field_values
+    list: '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
   - name: title_length
@@ -23,17 +379,104 @@ dataset_info:
     dtype: int64
   - name: is_open
     dtype: bool
-  - name: url
-    dtype: string
   splits:
   - name: train
     num_bytes: 23369260
     num_examples: 5000
   download_size: 8335420
   dataset_size: 23369260
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
 ---
+# Dataset Card for github-issues-augmented
+
+
+## Dataset Details
+
+### Dataset Description
+
+This dataset created and contains GitHub issue data including titles, descriptions, labels, states, and pull request information.
+
+- **Curated by:** 20157367, Ogwu
+- **License:** mit
+
+### Dataset Tags
+- github
+- issues
+- data-engineering
+- text-classification
+- nlp
+- machine-learning
+
+### Dataset Sources
+
+- **Repository:** https://huggingface.co/datasets/IO20157367/github-issues-augmented
+
+## Uses
+
+This dataset is intended to be used for text-classification, sentiment-analysis and FAISS indexing.
+
+
+## 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. -->
+
+Each row represents a single GitHub issue
+Key fields include:
+- url
+- -repository_url
+- id
+- number
+- title
+- state
+- is_open
+- is_pull_request
+- title_length
+- num_labels
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+This dataset was created to satisfy requirements of an assessed task for NMTAFE Data Science and AI.
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+The source data consists of publicly available GitHub issues and pull requests.
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+Data was collected using the GitHub REST API and Python requests. The JSON responses were converted into a structured dataset using the Hugging Face Datasets library. Additional derived features were generated, including issue status indicators, text length measurements, and label counts. The resulting dataset was converted into tabular format and uploaded to the Hugging Face Hub.
+
+## Compliance and Considerations
+
+### Privacy
+Dataset contains information obtained from publicly availble GitHub issues. Usernames, issue content, timestamps, and other metadata may be included because they are publicly accessible through the GitHub API. No additional personal information was collected beyond the publicly available source data.
+
+### Atribution
+Orifinal data sources should be acknowledged when using or redistributing the dataset:
+- GitHub REST API
+- HuggingFace Datasets
+
+### Storage
+The dataset should be securely stored. Extra care should be taken to ensure the information isn't transformed or engineered in a manner that creates privacy concerns or unintended profiling of individuals.
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The dataset is sourced from a single open-source software repository and may not represent software projects from different domains, organisations, or programming communities. Issue content may reflect the priorities, terminology, and workflows of the Hugging Face development community. The dataset may contain incomplete, outdated, or subjective information submitted by contributors.
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Users should consider the limited scope of the dataset when drawing conclusions or training models.
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Dataset Card Authors
+
+20157367, Ogwu
+
+## Dataset Card Contact
+20157367@tafe.wa.edu.au