Improve doc for task_description to highlight its importance to synthetic data generation #1083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sudheesh <[email protected]>
github-actions
bot
added
the
documentation
jjasghar
reviewed
May 21, 2024
bjhargrave
requested changes
May 21, 2024
| @@ -55,7 +55,7 @@ Your skills contribution pull requests must include the following: | |||
|
|
|||
| Taxonomy skill files must be a valid [YAML](https://yaml.org/) file named `qna.yaml`. Each `qna.yaml` files contains a set of key/value entries with the following keys: | |||
|
|
|||
| - `task_description`: A description of the skill. **Required** | |||
| - `task_description`: A description of the skill. This information is very critical and should be accurate. You should be able to mention `precise` to get precise generated data **Required** | |||
There was a problem hiding this comment.
Suggested change
| - `task_description`: A description of the skill. This information is very critical and should be accurate. You should be able to mention `precise` to get precise generated data **Required** | |
| - `task_description`: A description of the skill. | |
| This description is included in the prompt to the teacher model for generating the synthetic data. | |
| So you should make sure to use an accurate and sufficiently detailed description to guide the teacher model. | |
| The description can include instructions such as being precise or using brief answers. **Required** |
There was a problem hiding this comment.
@skairali Can you also look to make sure that task_description under knowledge is also updated to match this?
bjhargrave
changed the title
|
FYI @kelbrown20 |
|
This pull request has been automatically marked as stale because it has not had activity within 15 days. It will be automatically closed if no further activity occurs within 31 days. |
|
This is no longer valid. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change is to make sure that the importance of task_description is explicitly mentioned in the README
Removed the checklist which is not relevant for this change