Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: refine integrate with jina #492

Merged
merged 20 commits into from Jul 15, 2022
Merged

docs: refine integrate with jina #492

merged 20 commits into from Jul 15, 2022

Conversation

bwanglzu
Copy link
Member

@bwanglzu bwanglzu commented Jul 14, 2022 •
edited

Refine integration section in documentation. This gives user better knowledge on:

  1. how to use artifact_id and token to start FinetunerExecutor.
  2. how to use docker to start FinetunerExecutor (mount model)
  3. how to embed a DocumentArray, now we can only use post, not embed. We'll improve it later.

see it lively here

  • This PR references an open issue
  • I have added a line about this change to CHANGELOG

@github-actions github-actions bot added size/m and removed size/s labels Jul 14, 2022
@bwanglzu
Copy link
Member Author

i need to run the code again once we publish v0.9.2 executor

@bwanglzu bwanglzu linked an issue Jul 14, 2022 that may be closed by this pull request
refine documentation on integration finetuner with jina and docarray #487
Closed
@bwanglzu bwanglzu marked this pull request as ready for review July 14, 2022 13:26
jupyterjazz
jupyterjazz reviewed Jul 14, 2022
View reviewed changes
Copy link
Member

@jupyterjazz jupyterjazz left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that this page is a bit difficult to understand because it's code-heavy with small amount of explanations. Maybe we can add short comments into the code snippets explaining each line?

docs/walkthrough/integrate-with-jina.md Show resolved Hide resolved
docs/walkthrough/save-model.md Show resolved Hide resolved
docs/walkthrough/integrate-with-jina.md Show resolved Hide resolved
docs/walkthrough/integrate-with-jina.md Outdated Show resolved Hide resolved
gmastrapas
gmastrapas approved these changes Jul 15, 2022
View reviewed changes
docs/walkthrough/integrate-with-jina.md Outdated
@@ -8,14 +10,35 @@ We've created the [`FinetunerExecutor`](https://hub.jina.ai/executor/13dzxycc) w
More specifically, the executor exposes an `/encode` endpoint that embeds [Documents](https://docarray.jina.ai/fundamentals/document/) using the fine-tuned model.

Loading a tuned model is simple! You just need to provide a few parameters under the `uses_with` argument when adding the `FinetunerExecutor` to the [Flow]((https://docs.jina.ai/fundamentals/flow/)).
You will have three options:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have

@github-actions
Copy link

📝 Docs are deployed on https://ft-docs-update-integration--jina-docs.netlify.app 🎉

@bwanglzu bwanglzu merged commit ea90617 into main Jul 15, 2022
@bwanglzu bwanglzu deleted the docs-update-integration branch July 15, 2022 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jupyterjazz jupyterjazz jupyterjazz left review comments

@gmastrapas gmastrapas gmastrapas approved these changes

Assignees
No one assigned
Labels
area/docs area/setup size/m
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

refine documentation on integration finetuner with jina and docarray
3 participants
@bwanglzu @gmastrapas @jupyterjazz