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

Updates docs with reset, model lists #254

Merged
merged 14 commits into from
Jul 10, 2023
Merged
Prev Previous commit
Next Next commit
HuggingFace -> Hugging Face (as company name)
  • Loading branch information
JasonWeill authored and dlqqq committed Jul 10, 2023
commit afd03f08761562f1cfa71692ed01635c1bcf3585
8 changes: 4 additions & 4 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Jupyter AI supports the following model providers:

The environment variable names shown above are also the names of the settings keys used when setting up the chat interface.

You need the `pillow` Python package to use HuggingFace Hub's text-to-image models.
You need the `pillow` Python package to use Hugging Face Hub's text-to-image models.

You can find a list of Hugging Face's models at https://huggingface.co/models.

Expand Down Expand Up @@ -412,9 +412,9 @@ in notebooks while keeping the same concise syntax for invoking a language model

The `%ai list` subcommand prints a list of available providers and models. Some
providers explicitly define a list of supported models in their API. However,
other providers, like HuggingFace Hub, lack a well-defined list of available
other providers, like Hugging Face Hub, lack a well-defined list of available
models. In such cases, it's best to consult the provider's upstream
documentation. The [HuggingFace website](https://huggingface.co/) includes a
documentation. The [Hugging Face website](https://huggingface.co/) includes a
list of models, for example.

Optionally, you can specify a provider ID as a positional argument to `%ai list`
Expand Down Expand Up @@ -446,7 +446,7 @@ an `%%ai` command will be formatted as markdown by default. You can override thi
using the `-f` or `--format` argument to your magic command. Valid formats include:

- `code`
- `image` (for HuggingFace Hub's text-to-image models only)
- `image` (for Hugging Face Hub's text-to-image models only)
- `markdown`
- `math`
- `html`
Expand Down
2 changes: 1 addition & 1 deletion examples/images.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"metadata": {},
"source": [
"## Rapidly experimenting with different HF Hub models\n",
"We can call models on HuggingFace Hub that return images:"
"We can call models on Hugging Face Hub that return images:"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class CohereEmbeddingsProvider(BaseEmbeddingsProvider):

class HfHubEmbeddingsProvider(BaseEmbeddingsProvider):
id = "huggingface_hub"
name = "HuggingFace Hub"
name = "Hugging Face Hub"
models = ["*"]
model_id_key = "repo_id"
# ipywidgets needed to suppress tqdm warning
Expand Down
4 changes: 2 additions & 2 deletions packages/jupyter-ai-magics/jupyter_ai_magics/providers.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ class CohereProvider(BaseProvider, Cohere):

class HfHubProvider(BaseProvider, HuggingFaceHub):
id = "huggingface_hub"
name = "HuggingFace Hub"
name = "Hugging Face Hub"
models = ["*"]
model_id_key = "repo_id"
# ipywidgets needed to suppress tqdm warning
Expand Down Expand Up @@ -215,7 +215,7 @@ def validate_environment(cls, values: Dict) -> Dict:

# Handle image outputs
def _call(self, prompt: str, stop: Optional[List[str]] = None) -> str:
"""Call out to HuggingFace Hub's inference endpoint.
"""Call out to Hugging Face Hub's inference endpoint.

Args:
prompt: The prompt to pass into the model.
Expand Down