Skip to main content

Python Deep Learning Toolkit.

Project description

🔥 FlameAI

License PyPI GitHub CI Downloads

Python Deep Learning Toolkit.

Installation

Install the package:

pip install flameai

Update the package:

python3 -m pip install --upgrade pip
pip3 install --upgrade flameai

Example

Evaluate the performance of a binary classification model:

# 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)
$ 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]]

More examples: examples

Test Locally

Create a conda environment:

# 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):

# 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:

# Install pytest
pip install pytest

# Run tests
pytest

# Install nox
pip install nox

# Run nox
nox

Lint:

# Install flake8 and flake8-import-order
pip install flake8
pip install flake8-import-order

# Lint
flake8 --import-order-style google

Development

Build:

python3 -m pip install --upgrade build

python3 -m build

Upload:

python3 -m pip install --upgrade twine

twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flameai-1.0.9.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

flameai-1.0.9-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file flameai-1.0.9.tar.gz.

File metadata

  • Download URL: flameai-1.0.9.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for flameai-1.0.9.tar.gz
Algorithm Hash digest
SHA256 1e20c3828d978b7a37ef812db037f318bd3dff7698d145c6fdea039fec6f6eb9
MD5 10ef7f677b6a422f6a60b1d697e775ed
BLAKE2b-256 9977be23ef4e6e5386625ffb8e5dafeb2bf3dcc905788a9a639b9d76f3a724a3

See more details on using hashes here.

File details

Details for the file flameai-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: flameai-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for flameai-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 19f912c6f1135354415df3238402110205e66ce6fc50b9b6f006367a8808aa33
MD5 ec7d0f80405107e09646bf223146dc30
BLAKE2b-256 9b40959d5d85f8bfb2d4e88e2714da68b145cacac8a5db35b83e91cdd53949bb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page