mirror of
https://github.com/huggingface/candle.git
synced 2025-06-16 10:38:54 +00:00
8658df3485
* Begin to generate typehints. * generate correct stubs * Correctly include stubs * Add comments and typhints to static functions * ensure candle-pyo3 directory * Make `llama.rope.freq_base` optional * `fmt`
27 lines
621 B
Markdown
27 lines
621 B
Markdown
## Installation
|
|
|
|
From the `candle-pyo3` directory, enable a virtual env where you will want the
|
|
candle package to be installed then run.
|
|
|
|
```bash
|
|
maturin develop -r
|
|
python test.py
|
|
```
|
|
|
|
## Generating Stub Files for Type Hinting
|
|
|
|
For type hinting support, the `candle-pyo3` package requires `*.pyi` files. You can automatically generate these files using the `stub.py` script.
|
|
|
|
### Steps:
|
|
1. Install the package using `maturin`.
|
|
2. Generate the stub files by running:
|
|
```
|
|
python stub.py
|
|
```
|
|
|
|
### Validation:
|
|
To ensure that the stub files match the current implementation, execute:
|
|
```
|
|
python stub.py --check
|
|
```
|