From e518c5f271819f50e6494569f0bde0f7e259d1ab Mon Sep 17 00:00:00 2001
From: Silas Marvin <19626586+SilasMarvin@users.noreply.github.com>
Date: Tue, 14 Jan 2025 14:48:42 -0800
Subject: [PATCH] Added docs about trust remote code and huggingface
authentication
---
.../korvus/guides/constructing-pipelines.md | 45 +++++++++++++++++++
1 file changed, 45 insertions(+)
diff --git a/pgml-cms/docs/open-source/korvus/guides/constructing-pipelines.md b/pgml-cms/docs/open-source/korvus/guides/constructing-pipelines.md
index 975c0789a..ad9da09e9 100644
--- a/pgml-cms/docs/open-source/korvus/guides/constructing-pipelines.md
+++ b/pgml-cms/docs/open-source/korvus/guides/constructing-pipelines.md
@@ -162,3 +162,48 @@ pipeline = Pipeline(
The `Pipeline` above generates embeddings and tsvectors for the `abstract` and splits and generates embeddings and tsvectors for the `text`.
We can now perform search over both the `text` and `abstract` key of our documents. See the [guide for vector search](vector-search) for more information on how to do this.
+
+## Self-Hosting Specific Parameters
+
+**This section is only relevant for self hosted instances of PostgresML**. These parameters are never required for instances hosted by PostgresML.
+
+### Trust Remote Code
+
+Some HuggingFace models require the argument `trust_remote_code=true`. To enable this, pass it as a parameter in the pipeline construction:
+
+```python
+pipeline = Pipeline(
+ "v0",
+ {
+ "text": {
+ "semantic_search": {
+ "model": "Alibaba-NLP/gte-base-en-v1.5",
+ "parameters": {
+ "trust_remote_code": True
+ }
+ }
+ }
+ }
+)
+```
+
+### HuggingFace authentication
+
+Pass your HuggingFace token into the pipeline to access gated repos:
+
+```python
+pipeline = Pipeline(
+ "v0",
+ {
+ "text": {
+ "semantic_search": {
+ "model": "Alibaba-NLP/gte-base-en-v1.5",
+ "parameters": {
+ "trust_remote_code": True,
+ "token": "YOUR_TOKEN"
+ }
+ }
+ }
+ }
+)
+```
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy