## 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "candle-nn",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "blas,tensor,machine-learning",
"author": "The Candle Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2e/c5/461ef2a1e3530819e4a8e8d2b6bb01a11cc92b63a663509b7ca7a0633edf/candle_nn-0.2.3.tar.gz",
"platform": null,
"description": "## Installation \n\nFrom the `candle-pyo3` directory, enable a virtual env where you will want the\ncandle package to be installed then run.\n\n```bash\nmaturin develop -r \npython test.py\n```\n\n## Generating Stub Files for Type Hinting\n\nFor type hinting support, the `candle-pyo3` package requires `*.pyi` files. You can automatically generate these files using the `stub.py` script.\n\n### Steps:\n1. Install the package using `maturin`.\n2. Generate the stub files by running:\n ```\n python stub.py\n ```\n\n### Validation:\nTo ensure that the stub files match the current implementation, execute:\n```\npython stub.py --check\n```\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "Minimalist ML framework.",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/huggingface/candle",
"Source": "https://github.com/huggingface/candle"
},
"split_keywords": [
"blas",
"tensor",
"machine-learning"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1654dd07298bf45481f4596da57a84fdb95efb28e1440c0ee191b8c9fe6b2d0d",
"md5": "0eff8810b687c8b5eceba5c4d5596f88",
"sha256": "8ce654d5748503f946ce7b7f9abc607a851c8f797b607c914bf2c5deefc842d7"
},
"downloads": -1,
"filename": "candle_nn-0.2.3-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "0eff8810b687c8b5eceba5c4d5596f88",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 880685,
"upload_time": "2023-09-18T11:20:11",
"upload_time_iso_8601": "2023-09-18T11:20:11.840626Z",
"url": "https://files.pythonhosted.org/packages/16/54/dd07298bf45481f4596da57a84fdb95efb28e1440c0ee191b8c9fe6b2d0d/candle_nn-0.2.3-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8cc3d9dc470936b16f664d337b17607e658a8bca7189ab4a50618bafa417519e",
"md5": "17cc838e9c376e10fafa0c2f5154c2f9",
"sha256": "29b6e438233dc0b48a79987f2917642f027cb0f988552f446416d154f312dbaa"
},
"downloads": -1,
"filename": "candle_nn-0.2.3-cp310-cp310-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "17cc838e9c376e10fafa0c2f5154c2f9",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 1010272,
"upload_time": "2023-09-18T11:07:50",
"upload_time_iso_8601": "2023-09-18T11:07:50.516535Z",
"url": "https://files.pythonhosted.org/packages/8c/c3/d9dc470936b16f664d337b17607e658a8bca7189ab4a50618bafa417519e/candle_nn-0.2.3-cp310-cp310-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2ec5461ef2a1e3530819e4a8e8d2b6bb01a11cc92b63a663509b7ca7a0633edf",
"md5": "aa08c4ba16a98c4d9efe6eaacefca7d5",
"sha256": "8d885e084bc4a77a50e65c1efb154d4557059945af87585c59a60b7ec326b04e"
},
"downloads": -1,
"filename": "candle_nn-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "aa08c4ba16a98c4d9efe6eaacefca7d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 225957,
"upload_time": "2023-09-18T11:07:52",
"upload_time_iso_8601": "2023-09-18T11:07:52.957056Z",
"url": "https://files.pythonhosted.org/packages/2e/c5/461ef2a1e3530819e4a8e8d2b6bb01a11cc92b63a663509b7ca7a0633edf/candle_nn-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 11:07:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "huggingface",
"github_project": "candle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "candle-nn"
}