You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Auto merge of #153753 - Zalathar:rollup-Dq0luud, r=Zalathar
Rollup of 4 pull requests
Successful merges:
- #153432 (Fix some comments about dataflow analysis.)
- #153694 (fix(query): Pass Query Key to `value_from_cycle_error`)
- #153736 (add test that an incomplete feature emits a warning)
- #153750 (rustc-dev-guide subtree update)
Copy file name to clipboardExpand all lines: src/doc/rustc-dev-guide/src/autodiff/installation.md
+48-1Lines changed: 48 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,50 @@
1
1
# Installation
2
2
3
-
In the near future, `std::autodiff` should become available in nightly builds for users. As a contributor however, you will still need to build rustc from source. Please be aware that the msvc target is not supported at the moment, all other tier 1 targets should work. Please open an issue if you encounter any problems on a supported tier 1 target, or if you successfully build this project on a tier2/tier3 target.
3
+
In the near future, `std::autodiff` should become available for users via rustup. As a rustc/enzyme/autodiff contributor however, you will still need to build rustc from source.
4
+
For the meantime, you can download up-to-date builds to enable `std::autodiff` on your latest nightly toolchain, if you are using either of:
5
+
**Linux**, with `x86_64-unknown-linux-gnu` or `aarch64-unknown-linux-gnu`
6
+
**Windows**, with `x86_64-llvm-mingw` or `aarch64-llvm-mingw`
7
+
8
+
You can also download slightly outdated builds for **Apple** (aarch64-apple), which should generally work for now.
9
+
10
+
If you need any other platform, you can build rustc including autodiff from source. Please open an issue if you want to help enabling automatic builds for your prefered target.
11
+
12
+
## Installation guide
13
+
14
+
If you want to use `std::autodiff` and don't plan to contribute PR's to the project, then we recommend to just use your existing nightly installation and download the missing component. In the future, rustup will be able to do it for you.
15
+
For now, you'll have to manually download and copy it.
16
+
17
+
1) On our github repository, find the last merged PR: [`Repo`]
18
+
2) Scroll down to the lower end of the PR, where you'll find a rust-bors message saying `Test successful` with a `CI` link.
19
+
3) Click on the `CI` link, and grep for your target. E.g. `dist-x86_64-linux` or `dist-aarch64-llvm-mingw` and click `Load summary`.
20
+
4) Under the `CI artifacts` section, find the `enzyme-nightly` artifact, download, and unpack it.
21
+
5) Copy the artifact (libEnzyme-22.so for linux, libEnzyme-22.dylib for apple, etc.), which should be in a folder named `enzyme-preview`, to your rust toolchain directory. E.g. for linux: `cp ~/Downloads/enzyme-nightly-x86_64-unknown-linux-gnu/enzyme-preview/lib/rustlib/x86_64-unknown-linux-gnu/lib/libEnzyme-22.so ~/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-unknown-linux-gnu/lib`
22
+
23
+
Apple support was temporarily reverted, due to downstream breakages. If you want to download autodiff for apple, please look at the artifacts from this [`run`].
24
+
25
+
## Installation guide for Nix user.
26
+
27
+
This setup was recommended by a nix and autodiff user. It uses [`Overlay`]. Please verify for yourself if you are comfortable using that repository.
28
+
In that case you might use the following nix configuration to get a rustc that supports `std::autodiff`.
0 commit comments