add teaching comments to example YAML

Question

add teaching comments to example YAML

FionnD opened this issue 4 years ago · 6 comments

Feature Request

Based on a request from the community, it was suggested that we could add comments to YAML examples to better explain what's happening where.

wikipedia-sentences #698
multires-lyrics-search #698
cross-modal-search #698
query-while-indexing #665

Acceptance Criteria

This ticket is done when: Where possible, additionally comments have been added to the existing example YAML to show's what's happening. Please open a single PR with the suggestions and allow the dev role to review them as well.

Answer 1 · 2021-03-24T13:37:00.000Z

@rutujasurve94 Nan 'volunteered' you for this task, what do you think?

Answer 2 · 2021-04-28T21:45:12.000Z

I didn't see this before and the PR I made about updating fashion-mnist already takes care of its yaml files

Answer 3 · 2021-04-29T01:13:33.000Z

This is the PR for the other yaml files

Answer 4 · 2021-04-30T12:00:41.000Z

Can we tick the checkboxes in the main ticket description when a PR is merged?

Answer 5 · 2021-05-19T15:06:19.000Z

This issue is now being tracked in https://github.com/jina-ai/internal-tasks/issues/83

Answer 6 · 2021-08-05T13:09:03.000Z

Will work on this after #696