Skip to content

Commit c6df634

Browse files
authored
[DOCS] swap extra_headers for headers in updated sdk docs (#5100)
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]>
1 parent c47c899 commit c6df634

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

argilla/docs/getting_started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import argilla as rg
4343
client = rg.Argilla(
4444
api_url="<api_url>",
4545
api_key="<api_key>",
46-
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
46+
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
4747
)
4848
```
4949

argilla/docs/getting_started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ import argilla as rg
4949
client = rg.Argilla(
5050
api_url="<api_url>",
5151
api_key="<api_key>"
52-
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
52+
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
5353
)
5454
```
5555

argilla/docs/tutorials/text_classification.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
"client = rg.Argilla(\n",
121121
" api_url=\"https://[your-owner-name]-[your_space_name].hf.space\",\n",
122122
" api_key=\"owner.apikey\"\n",
123-
" # extra_headers={\"Authorization\": f\"Bearer {HF_TOKEN}\"}\n",
123+
" # headers={\"Authorization\": f\"Bearer {HF_TOKEN}\"}\n",
124124
")"
125125
]
126126
},

docs/_source/_common/snippets/start_page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import argilla as rg
3737
client = rg.Argilla(
3838
api_url="<api_url>",
3939
api_key="<api_key>"
40-
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
40+
# headers={"Authorization": f"Bearer {HF_TOKEN}"}
4141
)
4242
```
4343

0 commit comments

Comments
 (0)