Skip to content

Commit

Permalink
Update README.md (#46)
Browse files Browse the repository at this point in the history
*Issue #, if available:* #28 (also, PR #41)

*Description of changes:* This PR updates the README with information on
MLX support.


By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.
  • Loading branch information
abdulfatir authored Apr 8, 2024
1 parent 2042779 commit 93bdda7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ To perform inference with Chronos models, install this package by running:
```
pip install git+https://github.com/amazon-science/chronos-forecasting.git
```
> [!NOTE]
> We have added 🧪experimental support for [MLX](https://github.com/ml-explore/mlx) inference. If you have an Apple Silicon Mac, check out the [`mlx`](https://github.com/amazon-science/chronos-forecasting/tree/mlx) branch of this repository for instructions on how to install and use the MLX version of Chronos.
### Forecasting

Expand All @@ -48,7 +50,7 @@ from chronos import ChronosPipeline

pipeline = ChronosPipeline.from_pretrained(
"amazon/chronos-t5-small",
device_map="cuda",
device_map="cuda", # use "cpu" for CPU inference and "mps" for Apple Silicon
torch_dtype=torch.bfloat16,
)

Expand Down

0 comments on commit 93bdda7

Please sign in to comment.