Skip to content

Commit aeb7f4b

Browse files
Vaibhavs10julien-c
andauthored
Update Ollama docs. (#1521)
* Update Ollama docs. * Add huggingface-cli login. * suggestions from review. * Update docs/hub/ollama.md Co-authored-by: Julien Chaumond <[email protected]> * Update docs/hub/ollama.md Co-authored-by: Julien Chaumond <[email protected]> --------- Co-authored-by: Julien Chaumond <[email protected]>
1 parent 1070319 commit aeb7f4b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/hub/ollama.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
![cover](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/ollama/cover.png)
44

5+
🆕 You can now also run private GGUFs from the Hugging Face Hub.
6+
57
Ollama is an application based on llama.cpp to interact with LLMs directly through your computer. You can use any GGUF quants created by the community ([bartowski](https://huggingface.co/bartowski), [MaziyarPanahi](https://huggingface.co/MaziyarPanahi) and [many more](https://huggingface.co/models?pipeline_tag=text-generation&library=gguf&sort=trending)) on Hugging Face directly with Ollama, without creating a new `Modelfile`. At the time of writing there are 45K public GGUF checkpoints on the Hub, you can run any of them with a single `ollama run` command. We also provide customisations like choosing quantization type, system prompt and more to improve your overall experience.
68

79
Getting started is as simple as:
@@ -85,6 +87,13 @@ You can optionally configure a system prompt by putting it into a new file named
8587

8688
To change sampling parameters, create a file named `params` in the repository. The file must be in JSON format. For the list of all available parameters, please refer to [this documentation](https://github.com/ollama/ollama/blob/main/docs/modelfile.md#parameter).
8789

90+
## Run Private GGUFs from the Hugging Face Hub
91+
92+
You can run private GGUFs from your personal account or from an associated organisation account in two simple steps:
93+
94+
1. Copy your Ollama SSH key, you can do so via: `cat ~/.ollama/id_ed25519.pub | pbcopy`
95+
2. Add the corresponding key to your Hugging Face account by going to [your account settings](https://huggingface.co/settings/keys) and clicking on `Add new SSH key`.
96+
3. That's it! You can now run private GGUFs from the Hugging Face Hub: `ollama run hf.co/{username}/{repository}`.
8897

8998
## References
9099

0 commit comments

Comments
 (0)