Deploy c0111b4 to gh-pages

.cargo/config.toml

@@ -0,0 +1,8 @@
+[target.x86_64-unknown-linux-gnu]
+rustflags = ["-C", "target-cpu=native"]
+
+[target.aarch64-apple-darwin]
+rustflags = ["-C", "target-cpu=native"]
+
+[target.wasm32-unknown-unknown]
+rustflags = ["-C", "target-feature=+simd128"]

.github/workflows/book-cd.yml

@@ -0,0 +1,42 @@
+name: Deploy Rust book
+on:
+ # TODO put this back only when merging after this PR lands.
+ pull_request:
+ push:
+ branches:
+ - main
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write # To push a branch 
+ pull-requests: write # To create a PR from that branch
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - name: Install latest mdbook
+ run: |
+ tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+ url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+ mkdir mdbook
+ curl -sSL $url | tar -xz --directory=./mdbook
+ echo `pwd`/mdbook >> $GITHUB_PATH
+ - name: Deploy GitHub Pages
+ run: |
+ # This assumes your book is in the root of your repository.
+ # Just add a `cd` here if you need to change to another directory.
+ cd candle-book
+ mdbook build
+ git worktree add gh-pages
+ git config user.name "Deploy from CI"
+ git config user.email ""
+ cd gh-pages
+ # Delete the ref to avoid keeping history.
+ git update-ref -d refs/heads/gh-pages
+ rm -rf *
+ mv ../book/* .
+ git add .
+ git commit -m "Deploy $GITHUB_SHA to gh-pages"
+ git push --force --set-upstream origin gh-pages

.github/workflows/book.yml

@@ -0,0 +1,29 @@
+name: CI
+on: 
+ pull_request:
+
+jobs:
+ test:
+ name: Test candle-book
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write # To push a branch 
+ pull-requests: write # To create a PR from that branch
+ steps:
+ - uses: actions/checkout@master
+ - name: Install Rust
+ run: |
+ rustup set profile minimal
+ rustup toolchain install stable
+ rustup default stable
+ - name: Install latest mdbook
+ run: |
+ tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+ url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+ mkdir bin
+ curl -sSL $url | tar -xz --directory=bin
+ echo "$(pwd)/bin" >> $GITHUB_PATH
+ - name: Run tests
+ run: cd candle-book && mdbook test
+
+

.github/workflows/rust-ci.yml

@@ -0,0 +1,78 @@
+on: 
+ push:
+ branches: 
+ - main
+ pull_request:
+
+name: Continuous integration
+
+jobs:
+ check:
+ name: Check
+ runs-on: ${{ matrix.os }}
+ strategy:
+ matrix:
+ os: [ubuntu-latest, windows-latest, macOS-latest]
+ rust: [stable]
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: minimal
+ toolchain: ${{ matrix.rust }}
+ override: true
+ - uses: actions-rs/cargo@v1
+ with:
+ command: check
+ args: --workspace
+
+ test:
+ name: Test Suite
+ runs-on: ${{ matrix.os }}
+ strategy:
+ matrix:
+ os: [ubuntu-latest, windows-latest, macOS-latest]
+ rust: [stable]
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: minimal
+ toolchain: ${{ matrix.rust }}
+ override: true
+ - uses: actions-rs/cargo@v1
+ with:
+ command: test
+ args: --workspace
+
+ fmt:
+ name: Rustfmt
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: minimal
+ toolchain: stable
+ override: true
+ - run: rustup component add rustfmt
+ - uses: actions-rs/cargo@v1
+ with:
+ command: fmt
+ args: --all -- --check
+
+ clippy:
+ name: Clippy
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: minimal
+ toolchain: stable
+ override: true
+ - run: rustup component add clippy
+ - uses: actions-rs/cargo@v1
+ with:
+ command: clippy
+ args: --workspace --tests --examples -- -D warnings

.gitignore

@@ -0,0 +1,30 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+data/
+dist/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+*tokenizer*.json
+*.npz
+
+perf.data
+flamegraph.svg
+*.so
+*.swp
+trace-*.json
+
+candle-wasm-examples/*/*.bin
+candle-wasm-examples/*/*.wav
+candle-wasm-examples/*/*.safetensors
+candle-wasm-examples/*/package-lock.json

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "candle-examples/examples/flash-attn/cutlass"]
+ path = candle-flash-attn/cutlass
+ url = https://github.com/NVIDIA/cutlass.git

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+ - repo: https://github.com/Narsil/pre-commit-rust
+ rev: 2eed6366172ef2a5186e8785ec0e67243d7d73d0
+ hooks:
+ - id: fmt
+ name: "Rust (fmt)"
+ - id: clippy
+ name: "Rust (clippy)"
+ args:
+ [
+ "--tests",
+ "--examples",
+ "--",
+ "-Dwarnings",
+ ]