Skip to content

updated docs for knn metric #1

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 30, 2024
Merged

updated docs for knn metric #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/app/docs/dynamic-few-shot-text-classification/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,5 @@ from skllm.models.gpt.classification.few_shot import DynamicFewShotGPTClassifier
| `key` | `Optional[str]` | Estimator-specific API key; if None, retrieved from the global config, by default None. |
| `n_examples` | `int` | Number of closest examples per class to be retrieved, by default 3. |
| `memory_index` | `Optional[IndexConstructor]` | Custom memory index, for details check `skllm.memory` submodule, by default None. |
| `vectorizer` | `Optional[BaseVectorizer]` | Scikit-LLM vectorizer; if None, `GPTVectorizer` is used, by default None. |
| `vectorizer` | `Optional[BaseVectorizer]` | Scikit-LLM vectorizer; if None, `GPTVectorizer` is used, by default None. |
| `metric` | `Optional[str]` | Metric used for similarity search by the memory_index, by default "euclidean"