fix broken links, clarify documentation

This commit is contained in:
David Koski
2024-02-22 12:46:44 -08:00
parent c917f5b524
commit 5a83d7d92b
3 changed files with 21 additions and 6 deletions

View File

@@ -1,11 +1,19 @@
# Llama
This is a port of the llama model from:
This is a port of several models from:
- https://github.com/ml-explore/mlx-examples/blob/main/llms/mlx_lm/models/llama.py
- https://github.com/ml-explore/mlx-examples/blob/main/llms/mlx_lm/models/
You can use this to load models from huggingface, e.g.:
- https://huggingface.co/mlx-community/Mistral-7B-v0.1-hf-4bit-mlx
Currently supported model types are:
- Llama / Mistral
- Gemma
- Phi
See [Configuration.swift](Configuration.swift) for more info.
See [llm-tool](../../Tools/llm-tool)

View File

@@ -1,6 +1,6 @@
# MLX Swift Examples
Example (mlx-swift)[https://github.com/ml-explore/mlx-swift] programs.
Example [mlx-swift](https://github.com/ml-explore/mlx-swift) programs.
## LinearModelTraining
@@ -10,7 +10,7 @@ A simple linear model and a training loop.
## llm-tool
A command line tool for generating text using a Llama / Mistral model:
A command line tool for generating text using a variety of Hugging Face models:
- [README](Tools/llm-tool/README.md)

View File

@@ -2,7 +2,7 @@
See various READMEs:
- [Llama](../../Libraries/Llama/README.md)
- [LLM](../../Libraries/LLM/README.md)
### Building
@@ -21,7 +21,14 @@ To run this in Xcode simply press cmd-opt-r to set the scheme arguments. For ex
Then cmd-r to run.
> Note: you may be prompted for access to your Documents directory -- this is where
the huggingface HubApi stores the downloaded files.
the Hugging Face HubApi stores the downloaded files.
The model should be a path in the Hugging Face repository, e.g.:
- `mlx-community/Mistral-7B-v0.1-hf-4bit-mlx`
- `mlx-community/phi-2-hf-4bit-mlx`
See [LLM](../../Libraries/LLM/README.md) for more info.
### Running (Command Line)