Update README.md

README.md

@@ -1,398 +1,5 @@
----
-license: apache-2.0
-language:
-- en
-tags:
-- github
-- issues
-- npl
-- huggingface
-- text-classification
-- semantic-search
-pretty_name: This dataset contains GitHub issues (and their comments) collected from   the
-  [huggingface/datasets](https://github.com/huggingface/datasets) public repository.   It
-  was created as part of an NLP pipeline exercise to demonstrate data collection,   augmentation,
-  semantic search, and transformers inference.
-size_categories:
-- 1K<n<10K
-dataset_info:
-  features:
-  - name: url
-    dtype: large_string
-  - name: repository_url
-    dtype: large_string
-  - name: labels_url
-    dtype: large_string
-  - name: comments_url
-    dtype: large_string
-  - name: events_url
-    dtype: large_string
-  - name: html_url
-    dtype: large_string
-  - name: id
-    dtype: int64
-  - name: node_id
-    dtype: large_string
-  - name: number
-    dtype: int64
-  - name: title
-    dtype: large_string
-  - name: user
-    struct:
-    - name: avatar_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: login
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: site_admin
-      dtype: bool
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: url
-      dtype: string
-    - name: user_view_type
-      dtype: string
-  - name: labels
-    list:
-    - name: color
-      dtype: string
-    - name: default
-      dtype: bool
-    - name: description
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: name
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: url
-      dtype: string
-  - name: state
-    dtype: large_string
-  - name: locked
-    dtype: bool
-  - name: assignees
-    list:
-    - name: avatar_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: login
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: site_admin
-      dtype: bool
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: url
-      dtype: string
-    - name: user_view_type
-      dtype: string
-  - name: milestone
-    struct:
-    - name: closed_at
-      dtype: string
-    - name: closed_issues
-      dtype: int64
-    - name: created_at
-      dtype: string
-    - name: creator
-      struct:
-      - name: avatar_url
-        dtype: string
-      - name: events_url
-        dtype: string
-      - name: followers_url
-        dtype: string
-      - name: following_url
-        dtype: string
-      - name: gists_url
-        dtype: string
-      - name: gravatar_id
-        dtype: string
-      - name: html_url
-        dtype: string
-      - name: id
-        dtype: int64
-      - name: login
-        dtype: string
-      - name: node_id
-        dtype: string
-      - name: organizations_url
-        dtype: string
-      - name: received_events_url
-        dtype: string
-      - name: repos_url
-        dtype: string
-      - name: site_admin
-        dtype: bool
-      - name: starred_url
-        dtype: string
-      - name: subscriptions_url
-        dtype: string
-      - name: type
-        dtype: string
-      - name: url
-        dtype: string
-      - name: user_view_type
-        dtype: string
-    - name: description
-      dtype: string
-    - name: due_on
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: labels_url
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: number
-      dtype: int64
-    - name: open_issues
-      dtype: int64
-    - name: state
-      dtype: string
-    - name: title
-      dtype: string
-    - name: updated_at
-      dtype: string
-    - name: url
-      dtype: string
-  - name: comments
-    list: string
-  - name: created_at
-    dtype: timestamp[us, tz=UTC]
-  - name: updated_at
-    dtype: timestamp[us, tz=UTC]
-  - name: closed_at
-    dtype: timestamp[us, tz=UTC]
-  - name: assignee
-    struct:
-    - name: avatar_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: login
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: site_admin
-      dtype: bool
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: url
-      dtype: string
-    - name: user_view_type
-      dtype: string
-  - name: author_association
-    dtype: large_string
-  - name: issue_field_values
-    list: 'null'
-  - name: type
-    dtype: float64
-  - name: active_lock_reason
-    dtype: float64
-  - name: draft
-    dtype: float64
-  - name: pull_request
-    struct:
-    - name: diff_url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: merged_at
-      dtype: string
-    - name: patch_url
-      dtype: string
-    - name: url
-      dtype: string
-  - name: body
-    dtype: large_string
-  - name: closed_by
-    struct:
-    - name: avatar_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: login
-      dtype: string
-    - name: node_id
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: site_admin
-      dtype: bool
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: url
-      dtype: string
-    - name: user_view_type
-      dtype: string
-  - name: reactions
-    struct:
-    - name: '+1'
-      dtype: int64
-    - name: '-1'
-      dtype: int64
-    - name: confused
-      dtype: int64
-    - name: eyes
-      dtype: int64
-    - name: heart
-      dtype: int64
-    - name: hooray
-      dtype: int64
-    - name: laugh
-      dtype: int64
-    - name: rocket
-      dtype: int64
-    - name: total_count
-      dtype: int64
-    - name: url
-      dtype: string
-  - name: timeline_url
-    dtype: large_string
-  - name: performed_via_github_app
-    dtype: float64
-  - name: state_reason
-    dtype: large_string
-  - name: sub_issues_summary
-    struct:
-    - name: completed
-      dtype: int64
-    - name: percent_completed
-      dtype: int64
-    - name: total
-      dtype: int64
-  - name: issue_dependencies_summary
-    struct:
-    - name: blocked_by
-      dtype: int64
-    - name: blocking
-      dtype: int64
-    - name: total_blocked_by
-      dtype: int64
-    - name: total_blocking
-      dtype: int64
-  - name: pinned_comment
-    dtype: float64
-  - name: is_Pull_request
-    dtype: large_string
-  splits:
-  - name: train
-    num_bytes: 50319693
-    num_examples: 7972
-  download_size: 38960233
-  dataset_size: 50319693
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
-annotations_creators:
-- found
-language_creators:
-- found
-multilinguality:
-- monolingual
-source_datasets:
-- original
-task_categories:
-- text-classification
-- feature-extraction
-task_ids:
-- sentiment-analysis
+Here to put :
+Document data collection process.
+Identify compliance with applicable legislation/codes and your organisational policy alignment.
+Identify any risks; propose any required corrective action or possible future mitigation steps.
+Store dataset, notebook(s), and outputs according to organisational policies; document locations and versioning.