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 documentation for 0.7 #643

Merged
merged 70 commits into from
Jan 16, 2023
Merged

docs: refine documentation for 0.7 #643

merged 70 commits into from
Jan 16, 2023

Conversation

bwanglzu
Copy link
Member

@bwanglzu bwanglzu commented Dec 29, 2022 •
edited by guenthermi
Loading

The majority of the line changes comes out from Notebook, please ignore .ipynb files while reviewing.

Documentation Preview

  • A compact readme.
  • Add 3d mesh to Readme.
  • Get started session: Re-write how does it work section, deleted design principals section.
  • New advanced topics section. Includes how much data, negative mining, callbacks, training linear probe, FinetunerExecutor and self-hosting (empty).
  • Remove extra codes from the Google Colab (before and after plotting).
  • Docstring updates and better developer reference.
  • Re-write M-CLIP with the DE fashion dataset.
  • Add a subsection to explain num_items_per_class.

#629 #639 #647

Note: developer reference is not available in preview mode, please build docs locally.
Note: please do not merge before releasing.

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

@github-actions github-actions bot added size/s and removed size/xs labels Dec 29, 2022
@github-actions github-actions bot added size/m and removed size/s labels Dec 30, 2022
@github-actions github-actions bot added size/l and removed size/m labels Jan 2, 2023
@github-actions github-actions bot added size/xl and removed size/l labels Jan 2, 2023
@github-actions
Copy link

github-actions bot commented Jan 2, 2023

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

scott-martens
scott-martens reviewed Jan 2, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
scott-martens
scott-martens reviewed Jan 2, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
LMMilliken
LMMilliken reviewed Jan 13, 2023
View reviewed changes
Copy link
Contributor

@LMMilliken LMMilliken left a comment

Choose a reason for hiding this comment

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

Two small things in the inference section, looks good otherwise!

docs/walkthrough/inference.md Outdated Show resolved Hide resolved
docs/walkthrough/inference.md Outdated Show resolved Hide resolved
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@guenthermi @LMMilliken
refactor: Update docs/walkthrough/inference.md
be373d2 
Co-authored-by: Louis Milliken <58855099+LMMilliken@users.noreply.github.com>
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@guenthermi @LMMilliken
refactor: Update docs/walkthrough/inference.md
3dbb911 
Co-authored-by: Louis Milliken <58855099+LMMilliken@users.noreply.github.com>
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

LMMilliken
LMMilliken approved these changes Jan 16, 2023
View reviewed changes
Copy link
Contributor

@LMMilliken LMMilliken left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

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

@guenthermi @scott-martens
refactor: apply suggestions from code review
86b4a5f 
Co-authored-by: Scott Martens <70647348+scott-martens@users.noreply.github.com>
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

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

1 similar comment
@github-actions
Copy link

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

@guenthermi guenthermi merged commit 23aebe3 into main Jan 16, 2023
@guenthermi guenthermi deleted the docs-upgrade branch January 16, 2023 12:01
@guenthermi guenthermi mentioned this pull request Jan 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guenthermi guenthermi guenthermi approved these changes

@scott-martens scott-martens scott-martens left review comments

@LMMilliken LMMilliken LMMilliken approved these changes

@gmastrapas gmastrapas Awaiting requested review from gmastrapas

Assignees

@guenthermi guenthermi

@bwanglzu bwanglzu

Labels
area/core area/docs area/entrypoint size/xl
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@bwanglzu @scott-martens @guenthermi @LMMilliken