Skip to content

Commit 27ade53

Browse files
ckadnerbjhargrave
andauthored
docs: Avoid-these-topics has moved (#764)
Updating a few broken links and removing some dashes --------- Signed-off-by: Christian Kadner <[email protected]> Co-authored-by: BJ Hargrave <[email protected]>
1 parent 1fd736a commit 27ade53

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ Replace "..." with what you receive with the finetuned model. -->
5252
- [ ] All [commits are signed off](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md#legal) (DCO)
5353
- [ ] The `qna.yaml` file contains at least 5 `seed_examples`
5454
- [ ] The `qna.yaml` file was [linted](https://yamllint.com) and [prettified](https://onlineyamltools.com/prettify-yaml) ([yaml-validator](https://jsonformatter.org/yaml-validator) can do both)
55-
- [ ] An `attribution.txt` file in the same folder as the `qna.yaml` file.
55+
- [ ] An `attribution.txt` file in the same folder as the `qna.yaml` file
5656
- [ ] Content does not include PII or otherwise sensitive or confidential information
57-
- [ ] Content does not include anything documented in the project's [Avoid these Topics](https://github.com/instruct-lab/community/blob/main/docs/README.md#avoid-these-topics) guidelines
57+
- [ ] Content does not include anything documented in the project's [Avoid these Topics](https://github.com/instructlab/community/blob/main/docs/SKILLS_GUIDE.md#avoid-these-topics) guidelines

docs/contributing_via_GH_UI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ You will get a copy of the taxonomy repo in your github account. This is your ow
6161

6262
e. You can then click "commit changes" to your branch. The GitHub UI will prompt you to open a pull requestion. Select the "open pull request" button.
6363

64-
5. Verify that your YAML follows the proper structure. See [Knowledge: skills examples](https://github.com/instruct-lab/taxonomy/blob/main/README.md#knowledge-yaml-examples) and [Skills: YAML examples](https://github.com/instruct-lab/taxonomy/blob/main/README.md#skills-yaml-examples) to help with formatting. The [yamllint](https://www.yamllint.com/) tool is another great way to verify yaml.
64+
5. Verify that your YAML follows the proper structure. See [Knowledge: skills examples](https://github.com/instructlab/taxonomy/blob/main/README.md#knowledge-yaml-examples) and [Skills: YAML examples](https://github.com/instructlab/taxonomy/blob/main/README.md#skills-yaml-examples) to help with formatting. The [yamllint](https://www.yamllint.com/) tool is another great way to verify yaml.

docs/triaging/safe-responses.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
## Skills Content
44
### Jokes and Poems
5-
Thank you for taking the time to submit to instruct-lab! I know this wasn't easy and could have been quite time-consuming. Unfortunately, our team has decided that submissions for jokes or poems (skills and knowledge) are no longer supported or approved. We received so many at the beginning, and with jokes being "in the eye of the beholder" and puns requiring nuance for native English speakers, we realized we were possibly unconsciously biasing our model. We have discovered that working with both topics has its own challenges, and if we want something generalized, finding consensus was unsuccessful.
5+
Thank you for taking the time to submit to InstructLab! I know this wasn't easy and could have been quite time-consuming. Unfortunately, our team has decided that submissions for jokes or poems (skills and knowledge) are no longer supported or approved. We received so many at the beginning, and with jokes being "in the eye of the beholder" and puns requiring nuance for native English speakers, we realized we were possibly unconsciously biasing our model. We have discovered that working with both topics has its own challenges, and if we want something generalized, finding consensus was unsuccessful.
66

7-
We have updated the [avoid topics](https://github.com/instruct-lab/community/tree/main/docs#avoid-these-topics) to reflect this, and if you have more questions, don't hesitate to comment on this PR. We may revisit this in the future, but we are looking for unique skills or new knowledge for the model; poems and jokes, unfortunately, don't fit this plan.
7+
We have updated the [topics to avoid](https://github.com/instructlab/community/blob/main/docs/SKILLS_GUIDE.md#avoid-these-topics) to reflect this, and if you have more questions, don't hesitate to comment on this PR. We may revisit this in the future, but we are looking for unique skills or new knowledge for the model; poems and jokes, unfortunately, don't fit this plan.
88

9-
Thank you again for taking this time, and we are looking forward to your next PR to the instruct-lab project!
9+
Thank you again for taking this time, and we are looking forward to your next PR to the InstructLab project!
1010

1111
### Math
12-
LLMs aren't great at counting, math, or computation. Right now we're not seeking to improve the model's math and computation ability as this skill belongs to ["core skill"](https://github.com/instruct-lab/community/blob/main/docs/SKILLS_GUIDE.md#core-skills), which is not open to contribution.
12+
LLMs aren't great at counting, math, or computation. Right now we're not seeking to improve the model's math and computation ability as this skill belongs to ["core skill"](https://github.com/instructlab/community/blob/main/docs/SKILLS_GUIDE.md#core-skills), which is not open to contribution.
1313

1414
This will be rejected for now and we can reconsider if we open a math / computation taxonomy.
1515

1616
### Coding
1717

18-
Thanks for the submission! Coding belongs to ["core skill"](https://github.com/instruct-lab/community/blob/main/docs/SKILLS_GUIDE.md#core-skills), which is not open to contribution.
18+
Thanks for the submission! Coding belongs to ["core skill"](https://github.com/instructlab/community/blob/main/docs/SKILLS_GUIDE.md#core-skills), which is not open to contribution.
1919

2020
This will be rejected for now and we can reconsider if we open a programming / coding taxonomy.
2121

@@ -26,10 +26,10 @@ Closing this PR, but feel free to re submit as knowledge following those guideli
2626

2727
## Contribution Formatting Guidlines
2828
### Not Enough Examples
29-
Could you please make sure there are five examples with good diversity? We have recently updated the [readme](https://github.com/instruct-lab/taxonomy?tab=readme-ov-file#getting-started-with-skill-contributions) with the new requirement. Thank you for your contribution!
29+
Could you please make sure there are five examples with good diversity? We have recently updated the [readme](https://github.com/instructlab/taxonomy/blob/main/README.md#getting-started-with-skill-contributions) with the new requirement. Thank you for your contribution!
3030

3131
### Attribution
32-
Thanks for the submission! It looks interesting. Based on the [current guide](https://github.com/instruct-lab/taxonomy?tab=readme-ov-file#getting-started-with-skill-contributions), do you mind adding attribution to the examples?
32+
Thanks for the submission! It looks interesting. Based on the [current guide](https://github.com/instructlab/taxonomy/blob/main/README.md#getting-started-with-skill-contributions), do you mind adding attribution to the examples?
3333

3434
### Mentions of GPT, ChatGPT, Bard, or other proprietary LLMs
3535
Since this is a non-proprietary project, please remove all mentions of the names for commercial or proprietary LLM models; we are in favor of wordings like “LLMs”, or “Foundation Models”, etc.

0 commit comments

Comments
 (0)