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

[DOCS] swap extra_headers for headers in updated sdk docs #5100

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

burtenshaw
Copy link
Contributor

This PR passes the extra headers pass to Argilla down to the http client so that argilla sdk can be used with authenticate deployment like provate HF spaces.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested

Checklist

  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

LFTM! One remark, are we testing this flow somewhere, otherwise we can update it?

@burtenshaw
Copy link
Contributor Author

LFTM! One remark, are we testing this flow somewhere, otherwise we can update it?

No. I could unit test the client attribute.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@burtenshaw burtenshaw changed the title [FIX] pop and pass extra headers in argilla http client [DOCS] swap extra_headers for headers in updated sdk docs Jun 24, 2024
@burtenshaw
Copy link
Contributor Author

@davidberenstein1957 Thanks for pointing me to testing. On closer inspection I realised that the docs were wrong and we should be using headers not extra_headers.

@frascuchon can you confirm this please?

@frascuchon
Copy link
Member

@davidberenstein1957 Thanks for pointing me to testing. On closer inspection I realised that the docs were wrong and we should be using headers not extra_headers.

@frascuchon can you confirm this please?

Yes, @burtenshaw. the Argilla client exposes the httpx.Cient init args in the extra kwargs. Let us add some docs to the Argilla.init describing this (as we do with the APIClient definition

@frascuchon
Copy link
Member

@burtenshaw burtenshaw merged commit c6df634 into develop Jun 25, 2024
7 checks passed
@burtenshaw burtenshaw deleted the fix/extra-headers branch June 25, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants