Skip to content

Commit

Permalink
[DOCS] swap extra_headers for headers in updated sdk docs (#5100)
Browse files Browse the repository at this point in the history
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**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- 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/)

Co-authored-by: Ben Burtenshaw <[email protected]>
  • Loading branch information
burtenshaw and burtenshaw authored Jun 25, 2024
1 parent c47c899 commit c6df634
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion argilla/docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import argilla as rg
client = rg.Argilla(
api_url="<api_url>",
api_key="<api_key>",
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
)
```

Expand Down
2 changes: 1 addition & 1 deletion argilla/docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import argilla as rg
client = rg.Argilla(
api_url="<api_url>",
api_key="<api_key>"
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
)
```

Expand Down
2 changes: 1 addition & 1 deletion argilla/docs/tutorials/text_classification.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"client = rg.Argilla(\n",
" api_url=\"https://[your-owner-name]-[your_space_name].hf.space\",\n",
" api_key=\"owner.apikey\"\n",
" # extra_headers={\"Authorization\": f\"Bearer {HF_TOKEN}\"}\n",
" # headers={\"Authorization\": f\"Bearer {HF_TOKEN}\"}\n",
")"
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/_source/_common/snippets/start_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import argilla as rg
client = rg.Argilla(
api_url="<api_url>",
api_key="<api_key>"
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
)
```

Expand Down

0 comments on commit c6df634

Please sign in to comment.