| Name | flameai JSON |
| Version |
1.0.8
JSON |
| download |
| home_page | None |
| Summary | Python Deep Learning Toolkit. |
| upload_time | 2024-06-01 06:59:04 |
| maintainer | None |
| docs_url | None |
| author | luochang |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
deep learning
flameai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- <p align="center">
<img src="https://github.com/luochang212/flameai/raw/main/docs/_static/flame.jpeg" alt="logo" width=88%>
</p> -->
# 🔥 FlameAI
[](https://github.com/luochang212/flameai)
[](https://pypi.python.org/pypi/flameai)
[](https://github.com/luochang212/flameai)
[](https://github.com/luochang212/flameai/actions?query=workflow:CI)
[](https://pepy.tech/project/flameai)
Python Deep Learning Toolkit.
## Installation
Install the package:
```bash
pip install flameai
```
Update the package:
```bash
python3 -m pip install --upgrade pip
pip3 install --upgrade flameai
```
## Example
Evaluate the performance of a binary classification model:
```python
# simple.py
import flameai
y_true = [0, 0, 0, 1, 0, 1, 0, 1, 1, 0]
y_pred = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]
flameai.eval_binary(y_true, y_pred, threshold=0.5)
```
```bash
$ python examples/simple.py
threshold: 0.50000
accuracy: 0.70000
precision: 0.60000
recall: 0.75000
f1_score: 0.66667
auc: 0.70833
cross-entropy loss: 4.03816
True Positive (TP): 3
True Negative (TN): 4
False Positive (FP): 2
False Negative (FN): 1
confusion matrix:
[[4 2]
[1 3]]
```
Other examples: [examples](/examples/)
## Test Locally
Create a conda environment:
```bash
# Create env
mamba create -n python_3_10 python=3.10
# Activate env
conda activate python_3_10
# Check envs
conda info --envs
# Deactivate env
conda deactivate
# Remove env
conda env remove --name python_3_10
```
Install the package from source (or local wheel):
```bash
# Check if flameai has been installed
pip list | grep flameai
# Install from source
pip install -e .
# Or install from local wheel
# `pip install dist/flameai-[VERSION]-py3-none-any.whl`
# Uninstall
pip uninstall flameai
# Reinstall
pip uninstall flameai -y && pip install -e .
```
Test:
```bash
# Install pytest
pip install pytest
# Run tests
pytest
# Install nox
pip install nox
# Run nox
nox
```
Lint:
```bash
# Install flake8 and flake8-import-order
pip install flake8
pip install flake8-import-order
# Lint
flake8 --import-order-style google
```
## Development
Build:
```bash
python3 -m pip install --upgrade build
python3 -m build
```
Upload:
```bash
python3 -m pip install --upgrade twine
twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": null,
"name": "flameai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "deep learning, flameai",
"author": "luochang",
"author_email": "luochang212@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/54/84abc8cb0dac0f9ea0e93f6028597dc3cbc64e2ceda502ba161058e1176e/flameai-1.0.8.tar.gz",
"platform": null,
"description": "<!-- <p align=\"center\">\n<img src=\"https://github.com/luochang212/flameai/raw/main/docs/_static/flame.jpeg\" alt=\"logo\" width=88%>\n</p> -->\n\n\n# \ud83d\udd25 FlameAI\n\n[](https://github.com/luochang212/flameai)\n[](https://pypi.python.org/pypi/flameai)\n[](https://github.com/luochang212/flameai)\n[](https://github.com/luochang212/flameai/actions?query=workflow:CI)\n[](https://pepy.tech/project/flameai)\n\nPython Deep Learning Toolkit.\n\n## Installation\n\nInstall the package: \n\n```bash\npip install flameai\n```\n\nUpdate the package:\n\n```bash\npython3 -m pip install --upgrade pip\npip3 install --upgrade flameai\n```\n\n## Example\n\nEvaluate the performance of a binary classification model:\n\n```python\n# simple.py\nimport flameai\n\ny_true = [0, 0, 0, 1, 0, 1, 0, 1, 1, 0]\ny_pred = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]\n\nflameai.eval_binary(y_true, y_pred, threshold=0.5)\n```\n\n```bash\n$ python examples/simple.py\nthreshold: 0.50000\naccuracy: 0.70000\nprecision: 0.60000\nrecall: 0.75000\nf1_score: 0.66667\nauc: 0.70833\ncross-entropy loss: 4.03816\nTrue Positive (TP): 3\nTrue Negative (TN): 4\nFalse Positive (FP): 2\nFalse Negative (FN): 1\nconfusion matrix:\n[[4 2]\n [1 3]]\n```\n\nOther examples: [examples](/examples/)\n\n## Test Locally\n\nCreate a conda environment:\n\n```bash\n# Create env\nmamba create -n python_3_10 python=3.10\n\n# Activate env\nconda activate python_3_10\n\n# Check envs\nconda info --envs\n\n# Deactivate env\nconda deactivate\n\n# Remove env\nconda env remove --name python_3_10\n```\n\nInstall the package from source (or local wheel):\n\n```bash\n# Check if flameai has been installed\npip list | grep flameai\n\n# Install from source\npip install -e .\n\n# Or install from local wheel\n# `pip install dist/flameai-[VERSION]-py3-none-any.whl`\n\n# Uninstall\npip uninstall flameai\n\n# Reinstall\npip uninstall flameai -y && pip install -e .\n```\n\nTest:\n\n```bash\n# Install pytest\npip install pytest\n\n# Run tests\npytest\n\n# Install nox\npip install nox\n\n# Run nox\nnox\n```\n\nLint:\n\n```bash\n# Install flake8 and flake8-import-order\npip install flake8\npip install flake8-import-order\n\n# Lint\nflake8 --import-order-style google\n```\n\n## Development\n\nBuild:\n\n```bash\npython3 -m pip install --upgrade build\n\npython3 -m build\n```\n\nUpload:\n\n```bash\npython3 -m pip install --upgrade twine\n\ntwine upload dist/*\n```",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python Deep Learning Toolkit.",
"version": "1.0.8",
"project_urls": {
"bug-tracker": "https://github.com/luochang212/flameai/issues",
"documentation": "https://luochang212.github.io/posts/flameai",
"repository": "https://github.com/luochang212/flameai"
},
"split_keywords": [
"deep learning",
" flameai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17826c6a0a239f2d645baab00afdfeec2a7ce291bf83817103c50710aafabafd",
"md5": "acf73ec6159e777aa258f0886cce2653",
"sha256": "d566490ad1d20a7bf06c554106887154f3a49acc67c474e7c14278806a5873f6"
},
"downloads": -1,
"filename": "flameai-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acf73ec6159e777aa258f0886cce2653",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14993,
"upload_time": "2024-06-01T06:59:02",
"upload_time_iso_8601": "2024-06-01T06:59:02.108008Z",
"url": "https://files.pythonhosted.org/packages/17/82/6c6a0a239f2d645baab00afdfeec2a7ce291bf83817103c50710aafabafd/flameai-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c55484abc8cb0dac0f9ea0e93f6028597dc3cbc64e2ceda502ba161058e1176e",
"md5": "2c2367723f2f39fd191fa2a72abb726e",
"sha256": "e4a045a5c4edb963da60ba2dbb5c27f97967f523468e253f912f9f64fc0a4693"
},
"downloads": -1,
"filename": "flameai-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "2c2367723f2f39fd191fa2a72abb726e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41537,
"upload_time": "2024-06-01T06:59:04",
"upload_time_iso_8601": "2024-06-01T06:59:04.791153Z",
"url": "https://files.pythonhosted.org/packages/c5/54/84abc8cb0dac0f9ea0e93f6028597dc3cbc64e2ceda502ba161058e1176e/flameai-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-01 06:59:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "luochang212",
"github_project": "flameai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flameai"
}
