ci/Add Windows pipeline (#925)

Co-Authored-By: Sylvain Benner <[email protected]>

.github/workflows/test.yml

@@ -34,29 +34,36 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-13, ubuntu-22.04]
+        os: [macos-13, ubuntu-22.04, windows-2022]
         rust: [stable, 1.71.0]
         test: ['std', 'no-std', 'examples']
         include:
           - cache: stable
             rust: stable
           - cache: 1-71-0
             rust: 1.71.0
-          - coverage-flags: COVERAGE=1
+          - os: ubuntu-22.04
+            coverage-flags: COVERAGE=1
             rust: stable
             test: std
-            os: ubuntu-22.04
-          - wgpu-flags: DISABLE_WGPU=1
+          - os: macos-13
             rust: stable
             test: std
-            os: macos-13
+          - os: windows-2022
+            wgpu-flags: "DISABLE_WGPU=1"
+            # not used yet, as wgpu tests are disabled on windows for now
+            # see issue: https://github.com/tracel-ai/burn/issues/1062
+            # auto-graphics-backend-flags: "AUTO_GRAPHICS_BACKEND=dx12";'
         exclude:
           # only need to check this once
           - rust: 1.71.0
             test: 'examples'
-          # only need to check this once
+          # Do not run no-std tests on macos
           - os: macos-13
             test: 'no-std'
+          # Do not run no-std tests on Windows
+          - os: windows-2022
+            test: 'no-std'
 
     steps:
 
@@ -94,7 +101,7 @@ jobs:
           sudo apt install -y libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
 
       - name: Run cargo clippy for stable version
-        if: matrix.rust == 'stable' && matrix.test == 'std' && runner.os == 'Linux'
+        if: runner.os == 'Linux' && matrix.rust == 'stable' && matrix.test == 'std'
         uses: giraffate/clippy-action@v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -107,25 +114,61 @@ jobs:
           reporter: github-pr-check
 
       - name: Install grcov
-        if: matrix.rust == 'stable' && matrix.test == 'std' && runner.os == 'Linux'
+        if: runner.os == 'Linux' && matrix.rust == 'stable' && matrix.test == 'std'
         env:
           GRCOV_LINK: https://github.com/mozilla/grcov/releases/download
           GRCOV_VERSION: v0.8.18
         run: |
           curl -L "$GRCOV_LINK/$GRCOV_VERSION/grcov-x86_64-unknown-linux-musl.tar.bz2" |
           tar xj -C $HOME/.cargo/bin
 
+      - name: (windows) install warp
+        if: runner.os == 'Windows'
+        shell: bash
+        run: |
+          set -e
+
+          curl.exe -L https://www.nuget.org/api/v2/package/Microsoft.Direct3D.WARP/1.0.7.1 -o warp.zip
+          7z.exe e warp.zip -owarp build/native/amd64/d3d10warp.dll
+
+          mkdir -p target/debug/deps
+
+          cp -v warp/d3d10warp.dll target/debug/
+          cp -v warp/d3d10warp.dll target/debug/deps
+
+      - name: (windows) install mesa
+        if: runner.os == 'Windows'
+        shell: bash
+        run: |
+          set -e
+
+          curl.exe -L https://github.com/pal1000/mesa-dist-win/releases/download/23.2.1/mesa3d-23.2.1-release-msvc.7z -o mesa.7z
+          7z.exe e mesa.7z -omesa x64/{opengl32.dll,libgallium_wgl.dll,libglapi.dll,vulkan_lvp.dll,lvp_icd.x86_64.json}
+
+          mkdir -p target/debug/deps
+
+          cp -v mesa/* target/debug/
+          cp -v mesa/* target/debug/deps
+
+          echo "VK_DRIVER_FILES=$PWD/mesa/lvp_icd.x86_64.json" >> "$GITHUB_ENV"
+          echo "GALLIUM_DRIVER=llvmpipe" >> "$GITHUB_ENV"
+
+      - name: (windows) install directx
+        if: runner.os == 'Windows'
+        uses: napokue/[email protected]
+
       - name: run checks & tests
+        shell: bash
         run: ${{ matrix.coverage-flags }} ${{ matrix.wgpu-flags }} cargo xtask run-checks ${{ matrix.test }}
 
       - name: Codecov upload
-        if: matrix.rust == 'stable' && matrix.test == 'std' && runner.os == 'Linux'
+        if: runner.os == 'Linux' && matrix.rust == 'stable' && matrix.test == 'std'
         uses: codecov/codecov-action@v3
         with:
           files: lcov.info
 
   check-typos:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: checkout
         uses: actions/checkout@v4

Cargo.toml

@@ -48,7 +48,7 @@ fake = "2.9.1"
 flate2 = "1.0.28"
 float-cmp = "0.9.0"
 getrandom = { version = "0.2.11", default-features = false }
-gix-tempfile = { version = "8.0.0", features = ["signals"] }
+gix-tempfile = { version = "11.0.0", features = ["signals"] }
 hashbrown = "0.14.2"
 indicatif = "0.17.7"
 js-sys = "0.3.65"

burn-core/src/optim/adagrad.rs

@@ -169,7 +169,10 @@ mod tests {
         let grads = GradientsParams::from_grads(grads, &linear);
         let _linear = optimizer.step(LEARNING_RATE, linear, grads);
         BinFileRecorder::<FullPrecisionSettings>::default()
-            .record(optimizer.to_record(), "/tmp/test_optim".into())
+            .record(
+                optimizer.to_record(),
+                std::env::temp_dir().as_path().join("test_optim"),
+            )
             .unwrap();
 
         let state_optim_before = optimizer.to_record();

burn-core/src/optim/adam.rs

@@ -202,7 +202,10 @@ mod tests {
         let grads = GradientsParams::from_grads(grads, &linear);
         let _linear = optimizer.step(LEARNING_RATE, linear, grads);
         BinFileRecorder::<FullPrecisionSettings>::default()
-            .record(optimizer.to_record(), "/tmp/test_optim".into())
+            .record(
+                optimizer.to_record(),
+                std::env::temp_dir().as_path().join("test_optim"),
+            )
             .unwrap();
 
         let state_optim_before = optimizer.to_record();

burn-core/src/record/file.rs

@@ -309,7 +309,12 @@ mod tests {
 
     use crate as burn;
 
-    static FILE_PATH: &str = "/tmp/burn_test_file_recorder";
+    #[inline(always)]
+    fn file_path() -> PathBuf {
+        std::env::temp_dir()
+            .as_path()
+            .join("burn_test_file_recorder")
+    }
 
     #[test]
     fn test_can_save_and_load_jsongz_format() {
@@ -344,10 +349,10 @@ mod tests {
     fn test_can_save_and_load<Recorder: FileRecorder>(recorder: Recorder) {
         let model_before = create_model();
         recorder
-            .record(model_before.clone().into_record(), FILE_PATH.into())
+            .record(model_before.clone().into_record(), file_path())
             .unwrap();
 
-        let model_after = create_model().load_record(recorder.load(FILE_PATH.into()).unwrap());
+        let model_after = create_model().load_record(recorder.load(file_path()).unwrap());
 
         let byte_recorder = BinBytesRecorder::<FullPrecisionSettings>::default();
         let model_bytes_before = byte_recorder

burn-core/tests/derive_config.rs

@@ -24,15 +24,21 @@ pub enum TestEnumConfig {
     Named { first: f32, second: String },
 }
 
+#[cfg(feature = "std")]
+#[inline(always)]
+fn file_path(file_name: &str) -> std::path::PathBuf {
+    std::env::temp_dir().join(file_name)
+}
+
 #[cfg(feature = "std")]
 #[test]
 fn struct_config_should_impl_serde() {
     let config = TestStructConfig::new(2, 3.0, "Allow".to_string(), TestEmptyStructConfig::new());
-    let file_path = "/tmp/test_struct_config.json";
+    let file_path = file_path("test_struct_config.json");
 
-    config.save(file_path).unwrap();
+    config.save(&file_path).unwrap();
 
-    let config_loaded = TestStructConfig::load(file_path).unwrap();
+    let config_loaded = TestStructConfig::load(&file_path).unwrap();
     assert_eq!(config, config_loaded);
 }
 
@@ -52,35 +58,35 @@ fn struct_config_should_impl_display() {
 #[test]
 fn enum_config_no_value_should_impl_serde() {
     let config = TestEnumConfig::None;
-    let file_path = "/tmp/test_enum_no_value_config.json";
+    let file_path = file_path("test_enum_no_value_config.json");
 
-    config.save(file_path).unwrap();
+    config.save(&file_path).unwrap();
 
-    let config_loaded = TestEnumConfig::load(file_path).unwrap();
+    let config_loaded = TestEnumConfig::load(&file_path).unwrap();
     assert_eq!(config, config_loaded);
 }
 
 #[cfg(feature = "std")]
 #[test]
 fn enum_config_one_value_should_impl_serde() {
     let config = TestEnumConfig::Single(42.0);
-    let file_path = "/tmp/test_enum_one_value_config.json";
+    let file_path = file_path("test_enum_one_value_config.json");
 
-    config.save(file_path).unwrap();
+    config.save(&file_path).unwrap();
 
-    let config_loaded = TestEnumConfig::load(file_path).unwrap();
+    let config_loaded = TestEnumConfig::load(&file_path).unwrap();
     assert_eq!(config, config_loaded);
 }
 
 #[cfg(feature = "std")]
 #[test]
 fn enum_config_multiple_values_should_impl_serde() {
     let config = TestEnumConfig::Multiple(42.0, "Allow".to_string());
-    let file_path = "/tmp/test_enum_multiple_values_config.json";
+    let file_path = file_path("test_enum_multiple_values_config.json");
 
-    config.save(file_path).unwrap();
+    config.save(&file_path).unwrap();
 
-    let config_loaded = TestEnumConfig::load(file_path).unwrap();
+    let config_loaded = TestEnumConfig::load(&file_path).unwrap();
     assert_eq!(config, config_loaded);
 }
 

burn-core/tests/record_resilience.rs

@@ -175,11 +175,16 @@ mod tests {
             .unwrap();
     }
 
+    #[inline(always)]
+    fn file_path(filename: String) -> PathBuf {
+        std::env::temp_dir().join(filename)
+    }
+
     fn deserialize_with_new_optional_field<R>(name: &str, recorder: R) -> Result<(), RecorderError>
     where
         R: FileRecorder,
     {
-        let file_path: PathBuf = format!("/tmp/deserialize_with_new_optional_field-{name}").into();
+        let file_path: PathBuf = file_path(format!("deserialize_with_new_optional_field-{name}"));
         let model = Model {
             single_const: 32.0,
             linear1: nn::LinearConfig::new(20, 20).init::<TestBackend>(),
@@ -205,7 +210,7 @@ mod tests {
         R: FileRecorder,
     {
         let file_path: PathBuf =
-            format!("/tmp/deserialize_with_removed_optional_field-{name}").into();
+            file_path(format!("deserialize_with_removed_optional_field-{name}"));
         let model = ModelNewOptionalField {
             single_const: 32.0,
             linear1: nn::LinearConfig::new(20, 20).init::<TestBackend>(),
@@ -228,7 +233,7 @@ mod tests {
     where
         R: FileRecorder,
     {
-        let file_path: PathBuf = format!("/tmp/deserialize_with_new_constant_field-{name}").into();
+        let file_path: PathBuf = file_path(format!("deserialize_with_new_constant_field-{name}"));
         let model = Model {
             single_const: 32.0,
             array_const: [2, 2],
@@ -254,7 +259,7 @@ mod tests {
         R: FileRecorder,
     {
         let file_path: PathBuf =
-            format!("/tmp/deserialize_with_removed_constant_field-{name}").into();
+            file_path(format!("deserialize_with_removed_constant_field-{name}"));
         let model = ModelNewConstantField {
             single_const: 32.0,
             array_const: [2, 2],
@@ -277,7 +282,7 @@ mod tests {
     where
         R: FileRecorder,
     {
-        let file_path: PathBuf = format!("/tmp/deserialize_with_new_field_order-{name}").into();
+        let file_path: PathBuf = file_path(format!("deserialize_with_new_field_order-{name}"));
         let model = Model {
             array_const: [2, 2],
             single_const: 32.0,

xtask/src/utils.rs

@@ -39,7 +39,12 @@ pub(crate) fn get_workspaces(w_type: WorkspaceMemberType) -> Vec<WorkspaceMember
             let (workspace_name, workspace_path) =
                 (parts.first()?.to_owned(), parts.last()?.to_owned());
 
-            let workspace_path = workspace_path.replace("(path+file://", "").replace(')', "");
+            let prefix = if cfg!(target_os = "windows") {
+                "(path+file:///"
+            } else {
+                "(path+file://"
+            };
+            let workspace_path = workspace_path.replace(prefix, "").replace(')', "");
 
             match w_type {
                 WorkspaceMemberType::Crate