docs: add docs for eval callbacks for clip models #615
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
Member
guenthermi
commented
Nov 24, 2022
•
guenthermi
commented
- This adds documentation on how to use the evaluation callback for CLIP
- Add an EvaluationCallback to the clip fine-tuning examples
- Add a log output from the evaluation callback to the clip example
- This PR references an open issue
- I have added a line about this change to CHANGELOG
bwanglzu
requested changes
Nov 24, 2022
docs/notebooks/text_to_image.md
Outdated
Comment on lines
62
to
63
| eval_queries = DocumentArray.pull('fashion-eval-data-queries', show_progress=True) | ||
| eval_index = DocumentArray.pull('fashion-eval-data-index', show_progress=True) |
There was a problem hiding this comment.
shall we unify this to query_data and index_data?
| The evaluation callback is triggered at the end of each epoch, in which the model is evaluated using the `query_data` and `index_data` datasets that were provided when the callback was created. | ||
| These datasets can be provided in the same way the `train_data` and `eval_data` parameters of the {meth}`~finetuner.fit` method; either as a path to a CSV file, a {class}`~docarray.array.document.DocumentArray` or the name of a {class}`~docarray.array.document.DocumentArray` that has been pushed on the Jina AI Cloud. See {doc}`/walkthrough/create-training-data` for more information about how to prepare your data. | ||
|
|
||
| It is worth noting that the evaluation callback and the `eval_data` parameter of the fit method do not do the same thing. |
LMMilliken
approved these changes
Nov 24, 2022
gmastrapas
requested changes
Nov 24, 2022
docs/notebooks/text_to_image.md
Outdated
| @@ -41,7 +41,8 @@ For each product the dataset contains a title and images of multiple variants of | |||
| <!-- #region id="EVBez7dHwIye" --> | |||
| ## Data | |||
| Our journey starts locally. We have to [prepare the data and push it to the Jina AI Cloud](https://finetuner.jina.ai/walkthrough/create-training-data/) and Finetuner will be able to get the dataset by its name. For this example, | |||
| we already prepared the data, and we'll provide the names of training and evaluation data (`fashion-train-data-clip` and `fashion-eval-data-clip`) directly to Finetuner. | |||
| we already prepared the data, and we'll provide the names of traning and evaluation data (`fashion-train-data-clip` and `fashion-eval-data-clip`) directly to Finetuner. | |||
| In addition, we | |||
Co-authored-by: George Mastrapas <32414777+gmastrapas@users.noreply.github.com>
|
📝 Docs are deployed on https://ft-docs-clip-eval-callback--jina-docs.netlify.app 🎉 |
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.