From 744c83c1c0fbd36f516e7eaaac2d7cfd22f1ecf5 Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Mon, 22 Jul 2024 18:39:54 -0700 Subject: [PATCH] docs: add note on updating to new package --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58f7a49..a5cc088 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![CI](https://github.com/LuxDL/DeviceUtils.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/LuxDL/DeviceUtils.jl/actions/workflows/CI.yml) [![Buildkite](https://badge.buildkite.com/b098d6387b2c69bd0ab684293ff66332047b219e1b8f9bb486.svg?branch=main)](https://buildkite.com/julialang/DeviceUtils-dot-jl) -[![codecov](https://codecov.io/gh/LuxDL/DeviceUtils.jl/branch/main/graph/badge.svg?token=1ZY0A2NPEM)](https://codecov.io/gh/LuxDL/DeviceUtils.jl) +[![codecov](https://codecov.io/gh/LuxDL/LuxDeviceUtils.jl/branch/main/graph/badge.svg?token=1ZY0A2NPEM)](https://codecov.io/gh/LuxDL/LuxDeviceUtils.jl) [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac) @@ -21,3 +21,9 @@ Currently we provide support for the following backends: 2. `AMDGPU.jl` for AMD ROCM GPUs. 3. `Metal.jl` for Apple Metal GPUs. **(Experimental)** 4. `oneAPI.jl` for Intel GPUs. **(Experimental)** + +## Updating to v1.0 + + * Package was renamed from `LuxDeviceUtils.jl` to `DeviceUtils.jl`. + * `Lux(***)Device` has been renamed to `(***)Device`. + * `Lux(***)Adaptor` objects have been removed. Use `(***)Device` objects instead.