From 93bdda7f4bb6a4c65c48893cc13f77532f8d33b4 Mon Sep 17 00:00:00 2001 From: Abdul Fatir Date: Mon, 8 Apr 2024 17:27:11 +0200 Subject: [PATCH] Update README.md (#46) *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. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cae2891..8567b9d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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, )