More Model Module Docs

[zachcp]

As per Discord discussion, continuing to update the model docs.

[LaurentMazare]

There seems to be some clippy errors in the CI. Could you have a look?

[zachcp]

( yep. but AFK )

[zachcp]

New error is in unintended eval of markdown block. will look into fix

//! ```no_run
//! // for sentence embeddings
//! # use candle_core::Tensor;
//! # use candle_nn::{VarBuilder, Module};
//! # fn main() -> candle_core::Result<()> {
//! # let model = todo!();

[zachcp]

To have text highlighting without execution you can use the following:

//! ```rust,text

[zachcp]

I'm removing the 2 offending text blocks for the moment. I can compile just fine locally and am not sure where the discrepancy lies between my machine and the CI system. Elide the issue for the moment.

[zachcp]

This error is unrelated to my PR. I believe it may have been introduced in #2618

error: failed to run custom build command for `pyo3-build-config v0.22.6`
Error: failed to run custom build command for `pyo3-build-config v0.22.6`
Caused by:
  process didn't exit successfully: `D:\a\candle\candle\target\debug\build\pyo3-build-config-54d91561316d6713\build-script-build` (exit code: 1)
  --- stdout
  cargo:rerun-if-env-changed=PYO3_CONFIG_FILE
  cargo:rerun-if-env-changed=PYO3_NO_PYTHON
  cargo:rerun-if-env-changed=PYO3_ENVIRONMENT_SIGNATURE
  cargo:rerun-if-env-changed=PYO3_PYTHON
  cargo:rerun-if-env-changed=VIRTUAL_ENV
  cargo:rerun-if-env-changed=CONDA_PREFIX
  cargo:rerun-if-env-changed=PATH

  --- stderr
  error: cannot set a minimum Python version 3.11 higher than the interpreter version 3.9 (the minimum Python version is implied by the abi3-py311 feature)
warning: build failed, waiting for other jobs to finish...

[zachcp]

Bumped the gh-action ci to python 3.11/

[zachcp]

Hmmm.... still failing on Windows due to python version incompatibility

[zachcp]

from pyo3: https://github.com/PyO3/pyo3/blob/main/.github/workflows/ci.yml

jobs:
  fmt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - run: python -m pip install --upgrade pip && pip install nox
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: Check python formatting and lints (ruff)
        run: nox -s ruff
      - name: Check rust formatting (rustfmt)
        run: nox -s rustfmt

[zachcp]

Ok. windows:Check passes but I missed Windows:test. Updated. should now all pass.

[zachcp]

• Ubuntu failed due to not enough space on disk.
• Can I recommend: rerun the windows:test that didn't run and if it passes then accept the PR?