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.

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

refactor: add docs and remove connect function #596

Merged
merged 5 commits into from
Nov 4, 2022

Conversation

guenthermi
Copy link
Member

@guenthermi guenthermi commented Nov 4, 2022

This PR fix some minor issues with the login functionalities and the documentation in general

  • add docstring to login function
  • add documentation for the force parameter
  • remove connect function which got useless since the force parameter was introduced by hubble
  • fix some links to functions in the documentation and remove wrong links to functions in the notebooks.

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

@guenthermi guenthermi marked this pull request as draft November 4, 2022 09:07
@guenthermi guenthermi requested review from gmastrapas, bwanglzu, LMMilliken and scott-martens and removed request for gmastrapas November 4, 2022 10:51
@guenthermi guenthermi marked this pull request as ready for review November 4, 2022 10:52
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

LGTM!

finetuner/__init__.py Outdated Show resolved Hide resolved
Co-authored-by: George Mastrapas <32414777+gmastrapas@users.noreply.github.com>
@@ -280,7 +281,7 @@
"cell_type": "code",
"source": [
"text_da = DocumentArray([Document(text='some text to encode')])\n",
"image_da = DocumentArray([Document(uri='my-image.png')])\n",
"image_da = DocumentArray([Document(uri='https://www.collinsdictionary.com/images/full/apple_158989157.jpg')])\n",
Copy link
Member

Choose a reason for hiding this comment

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

Not a free-use image. Try to use free-use images with known origins and stable URLs. Like this one: https://upload.wikimedia.org/wikipedia/commons/4/4e/Single_apple.png

@@ -177,7 +177,7 @@ let's use the fine-tuned model to encode a new `Document`:

```python id="v95QsuEyzE-B"
text_da = DocumentArray([Document(text='some text to encode')])
image_da = DocumentArray([Document(uri='my-image.png')])
image_da = DocumentArray([Document(uri='https://www.collinsdictionary.com/images/full/apple_158989157.jpg')])
Copy link
Member

Choose a reason for hiding this comment

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

Not a free-use image. Try to use free-use images with known origins and stable URLs. Like this one: https://upload.wikimedia.org/wikipedia/commons/4/4e/Single_apple.png

@scott-martens
Copy link
Member

Docs look fine except for the apple picture not being free-use and not having any guarantee of a stable URL. Replace it with https://upload.wikimedia.org/wikipedia/commons/4/4e/Single_apple.png

@github-actions github-actions bot added size/m and removed size/s labels Nov 4, 2022
@guenthermi
Copy link
Member Author

ok it produced lots of changes in the text-to-text colab, but I did not found a way to prevent it from it, without edititing the source code of the colab manually.

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

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

@guenthermi guenthermi merged commit 92b55de into main Nov 4, 2022
@guenthermi guenthermi deleted the refactor-login-functions branch November 4, 2022 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants