Skip to content

Commit

Permalink
(chore) Remove created_by field (#475)
Browse files Browse the repository at this point in the history
Please see https://github.com/instruct-lab/cli/issues/220 for more
details.

Signed-off-by: Anik Bhattacharjee <[email protected]>
  • Loading branch information
anik120 committed Mar 13, 2024
1 parent a9803e4 commit ba25a8a
Show file tree
Hide file tree
Showing 65 changed files with 3 additions and 74 deletions.
1 change: 0 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ jobs:
if [[ "$file" != *"/qna.yaml" ]]; then
error "1:1: Skills file has to be named 'qna.yaml', not '$(basename $file)'"
fi
yq '.created_by | length > 0' $file | grep -q false && warn "$(yq '.created_by|line' $file):1: missing/empty 'created_by'"
yq '.task_description | length > 0' $file | grep -q false && warn "$(yq '.task_description|line' $file):1: missing/empty 'task_description'"
yq '.seed_examples' $file | grep -q null && error "$(yq '.seed_examples|line' $file):1: missing 'seed_examples'"
yq '.seed_examples | length >= 5' $file | grep -q false && error "$(yq '.seed_examples|line' $file):1: less than 5 'seed_examples'"
Expand Down
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ Each `qna.yaml` file is required to contain a minimum of five question and
answer pairs. The `qna.yaml` format should include the following fields:

- `seed_examples` (five or more examples of question and answer pairs)
- `created_by` (your GitHub username)
- `task_description` (an optional description of the skill).

#### Freeform compositional skill: YAML example
Expand All @@ -83,7 +82,6 @@ This example assumes the GitHub username `mairin`:
``` yaml
task_description: |
The pun task enables the telling of funny pun-based jokes.
created_by: mairin # Use your GitHub username; only one creator supported
seed_examples:
- question: Tell me a pun about birds.
answer: | # The | is needed to escape characters like ` or '
Expand Down Expand Up @@ -141,7 +139,6 @@ This example assumes the GitHub username `mairin`:
``` yaml
task_description: |
This skill provides the ability to read a markdown-formatted table.
created_by: mairin # Use your GitHub username; only one creator supported
seed_examples:
- context: |
| **Breed** | **Size** | **Barking** | **Energy** |
Expand Down Expand Up @@ -218,15 +215,13 @@ pairs. The `qna.yaml` format should include the following fields:

- `seed_examples` (five or more examples sourced from the provided knowledge
documents)
- `created_by` (your GitHub username)
- `task_description` (an optional description of the knowledge).

#### Knowledge: yaml example

``` yaml
task_description: |
Knowledge about Taylor Swift's music.
created_by: mairin # Use your GitHub username; only one creator supported
seed_examples:
- question: |
Is Taytay coming to Boston in 2024?
Expand Down Expand Up @@ -329,26 +324,24 @@ referenced above might look like in the tree:

Taxonomy skill files can be any valid [YAML](https://yaml.org/) file ending in
`.yaml` containing a set of key/value entries, in which the following three
keys are recognized: `task_description`, `created_by`, and `seed_examples`.
keys are recognized: `task_description` and `seed_examples`.

* The value of the `task_description` key can be any string.
* The value of the `created_by` key can be any string.
* The value of the `seed_examples` key is a collection of one or more key/value entries in which the
three recognized keys are: `context`, `question`, and `answer`, each of which can have any string
as value. For an entry to be valid, it **MUST** have the question and answer specified.

Other keys at any level are currently ignored.

To make these files easier and faster for humans to read, it is recommended to
specify the `task_description` first, followed by `created_by`, and finally
`seed_examples`. In `seed_examples`, it is recommended to specify the `context`
specify the `task_description` first, followed by `seed_examples`.
In `seed_examples`, it is recommended to specify the `context`
first (if applicable), followed by the `question`, and finally the `answer`.

So in essence the format looks something like this:

``` yaml
task_description: <string>
created_by: <string>
seed_examples:
- question: <string>
answer: |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Kanye Omari West is a renowned American rapper, singer, songwriter, record

Check failure on line 2 in compositional_skills/extraction/abstractive/abstract/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
producer, entrepreneur, and fashion designer, known for his broad range of musical
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '1. Etan Boritzer is an American writer of children\''s literature, best

Check failure on line 2 in compositional_skills/extraction/abstractive/key_points/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
known for his book "What is God?" published in 1989.\n2. His "What is?" series,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'The main takeaways from the above text are:\n\n1. Up Front is a 1951 comedy

Check failure on line 2 in compositional_skills/extraction/abstractive/main_takeaway/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
film directed by Alexander Hall, starring Tom Ewell and David Wayne, based on
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "I. Hanro Smitsman\\n\\n* Born in 1967 in Breda, Netherlands\\n* Writer\

Check failure on line 2 in compositional_skills/extraction/abstractive/outline/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
\ and director of film and television\\n* Known for \"Trilogie,\" consisting of\
Expand Down
1 change: 0 additions & 1 deletion compositional_skills/extraction/abstractive/title/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Directors Across Borders: A Comparative Study of International Film and

Check failure on line 2 in compositional_skills/extraction/abstractive/title/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
Museum Directors, from Luciano Salce to Brian Patrick Kennedy'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '- 5

Check failure on line 2 in compositional_skills/extraction/inference/qualitative/sentiment/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null

Check failure on line 2 in compositional_skills/extraction/inference/qualitative/tone_and_style/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

missing 'seed_examples'

Check failure on line 2 in compositional_skills/extraction/inference/qualitative/tone_and_style/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

less than 5 'seed_examples'

Check failure on line 2 in compositional_skills/extraction/inference/qualitative/tone_and_style/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

missing/empty 'question's

Check failure on line 2 in compositional_skills/extraction/inference/qualitative/tone_and_style/qna.yaml

View workflow job for this annotation

GitHub Actions / lint

missing/empty 'answer's
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Q1: High 200, Low 100; Q2: High 210, Low 110; Q3: High 220, Low 120; Q4:
High 230, Low 130'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: stars, 2\nmoon, 1\nsun, 1
context: '''"Under the night sky, the moon shone brightly, surrounded by countless
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Here is a list of dates and events from the provided text:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '''1. Niels Hansen\n2. Harry Piel (also known as Hubert August Piel)\n3.
Dary Holm\n4. Elisabeth Pinajeff\n5. Hans Junkermann\n6. Robert A. Dietrich\n7.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '''1. Ireland\n2. Australia\n3. United States\n4. Peabody Essex Museum (in
the United States)\n5. Toledo Museum of Art in Ohio\n6. Hood Museum of Art\n7.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: null
context: null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '1. "Eco-Hero Challenge": Create an interactive campaign that encourages
customers to become "Eco-Heroes" by switching to your sustainable home products.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Sure, I'd be happy to help you explore this topic. The use of genetically\
\ modified (GM) mosquitoes is a complex issue with potential benefits and challenges.\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '1. Universal healthcare ensures equitable access to medical services: A
just society is one that strives to provide equal opportunities and resources
Expand Down
1 change: 0 additions & 1 deletion compositional_skills/writing/freeform/debate/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: Economist:\n"Implementing a universal basic income (UBI) could significantly
reduce poverty rates and provide a financial safety net for individuals who lose
Expand Down
1 change: 0 additions & 1 deletion compositional_skills/writing/freeform/jokes/puns/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: mairin
seed_examples:
- answer: 'Why do birds eat wood?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "# Licensing Agreement\n\nThis Licensing Agreement (\"Agreement\") is entered\
\ into on [Date], by and between [Your Full Name or Company Name] (\"Licensor\"\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "# Business Contract\n\nThis Business Contract (\"Contract\") is entered\
\ into on [Date], by and between [Your Full Name or Company Name] (\"Service Provider\"\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '(Verse 1)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'In the heart of a forest, vast and green,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'In the waning days of summer''s reign,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Crimson leaf adrift,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'A flower so bright in the glade,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'In the heart of the valley, where time''s river flows,
Expand Down
1 change: 0 additions & 1 deletion compositional_skills/writing/freeform/poetry/ode/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Ode to the Lightning''s Power and Inspiration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'In autumn''s grand and regal tapestry,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Restorative justice practices have been gaining traction in schools and\
\ communities due to their transformative approach to conflict resolution and\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'Subject: Inquiry Regarding the Status of My Internship Application
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Subject: Help Me Plan a Surprise Party \U0001F38A\U0001F92B\n\nHey [Friend's\
\ Name],\n\nI hope you're having a fantastic day! I've got this brilliant idea\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '**Title: "The Final Heist"**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "In the quiet corners of Emily's creative mind lay a realm of her own making,\
\ a world she had filled with vibrant colors, enchanting characters, and extraordinary\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Hey friends! \U0001F31F Let's talk about organization and time management\
\ hacks! \U0001F4C5\U0001F4DD I'm always looking for new ways to stay on top of\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Seizing the city life with my squad! \U0001F3D9\uFE0F\U0001F483 This weekend,\
\ we're trading serenity for skyscrapers and tranquility for traffic. Can't wait\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: 'I am delighted to recommend [Name] for any professional opportunity that
comes their way. As a [their job title], they consistently demonstrated a high
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Embrace the grind and let your passion fuel your purpose! \U0001F4AA\U0001F525\
\ This #MotivationMonday, remember that every challenge is an opportunity in disguise.\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '# Technical Guide: Implementing a Containerization Strategy with Docker
and Kubernetes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "**Discover the Magic of [Your Brand] Hand-Painted Wall Art - One-of-a-Kind,\
\ Durable, and Versatile Masterpieces for Your Space!**\n\nTransform your living\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '# Technical Proposal: Mobile App Development
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '# Technical Report: Microservices Architecture in Software Development
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '# Technical Specification: Advanced Data Compression Module
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '# Manual: Performing a Security Audit for Small to Medium-Sized Businesses
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Henry Edwards (18 September 1882 \u2013 2 November 1952) was an English\
\ actor and film director.\\n\\nHe appeared in 81 films between 1915 and 1952.\\\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: Deswa is an Indian Bhojpuri language film written and directed by Nitin
Chandra.\n\nThe film is a social drama - crime thriller Bhojpuri genre.\n\nThe
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Qarah Tappeh( also Romanized as Qareh Tappeh; also known as Qar\u0101 Tappeh,\
\ Qara Tepe, and R\u016Bst\u0101 -ye Qarah Tappeh) is a village in Rahal Rural\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '1. Enhance the onboarding process to engage and commit new hires.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "Subject: Recap and Next Steps - Customer Journey Mapping and Analysis\n\
\nDear [Company Name] Team,\n\nI hope this email finds you well. Yesterday, we\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: The executive summary of the financial literacy training meeting highlights
the importance of financial literacy for employees, its potential impact on job
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '**Minutes of Meeting**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: Qurt Tappeh is a name of several villages in West Azerbaijan, Ardabil, and
Razavi Khorasan provinces of Iran. In 2006, the population of Qurt Tappeh in West
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: "\"The text provided gives information about various individuals who are\
\ directors in different fields such as film, television, theatre, art museums,\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '1. Chester High School is a public high school located in Chester, Pennsylvania,
serving the City of Chester, Chester Township, and Upland. It is part of the Chester-Upland
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: '"I. Brooks Benedict\n A. American actor of the silent and sound film
era\n B. Played supporting and utility roles in over 300 films, mostly uncredited\n\nII.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: shivsr
seed_examples:
- answer: The text provides information about several members of the Arbuthnott family,
including General Sir Hugh Arbuthnot, KCB, and other Viscounts of Arbuthnott,
Expand Down
1 change: 0 additions & 1 deletion knowledge/technical_manual/ibm_redbooks/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: Abhi-B
domain: ibm redbooks
seed_examples:
- answer: The Cross Applications - Situation Handling capability in SAP S/4HANA allows
Expand Down
1 change: 0 additions & 1 deletion knowledge/textbook/history/qna.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
created_by: Abhi-B
domain: history
seed_examples:
- answer: Wealthy Safavid women raised their public stature by becoming patrons of
Expand Down

0 comments on commit ba25a8a

Please sign in to comment.