Skip to main content

Ikaris - Open-source Hugging Face model safety checker

Project description

Ikaris

PyPI version Python version License

Ikaris is an open-source CLI tool for verifying the security of machine learning models from Hugging Face. Ikaris performs multi-layer checks to help users assess risks before deploying models in production environments.

✨ Main Feature

Ikaris performs model verification based on three methods:

🔍 Source Verification

Identifies the model creator and publisher, as well as basic metadata.

📁 File and Folder Safety Review

Review the structure and contents of the model repository for suspicious or non-standard content.

📄 Model Card and Metadata Review

Validate model documentation and metadata.

📦 Installation

Make sure you are using Python >=3.8, then install Ikaris via pip:

Using pip:

pip install ikaris

🚀 Usage

Basic usage example for checking models:

ikaris check hf-model tensorblock/Llama-3-ELYZA-JP-8B-GGUF

Another example :

ikaris check hf-model tencent/HunyuanVideo-Avatar

Output Sample

----------------------------------------
Source Verification
----------------------------------------
INFO: Source: https://huggingface.co/tensorblock/Llama-3-ELYZA-JP-8B-GGUF
INFO: Creator: tensorblock
WARNING: Model Publisher: Unknown
INFO: Tags: [...]
INFO: Downloads: 196
----------------------------------------
File & Folder Review
----------------------------------------
INFO: README.md is Safe
... (file lainnya)
----------------------------------------
Model Card Review
----------------------------------------
INFO: This model contains clear documentation.
INFO: This model contains clear metadata.

Summary: 20 Info, 1 Warning, 0 Critical

📁 Project Structure

Ikaris 
├── checker    ├── __init__.py    ├── file_verification.py    ├── model_card_verification.py    └── source_verification.py
├── helpers    ├── __init__.py    └── logging.py
├── __init__.py
└── main.py

🔧 Prerequisite

  • Python >= 3.8
  • huggingface_hub >= 0.32.4
  • colorama >= 0.4.6

📝 License

Distribution under license: Apache 2.0

👤 Contributor

⚠️ Disclaimer

Ikaris is not a substitute for a full security audit. Use Ikaris results as an initial analysis, and combine them with manual checks for model usage on sensitive production systems.

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

ikaris-0.1.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ikaris-0.1.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file ikaris-0.1.1.tar.gz.

File metadata

  • Download URL: ikaris-0.1.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for ikaris-0.1.1.tar.gz
Algorithm Hash digest
SHA256 22b9be5ed4525b2c138e8ebb955198e19ec2b35ede923d64287b5a2d7187f971
MD5 290e67eddcea381b24980d873b2fa111
BLAKE2b-256 d66622aa3050a7a016ce1d9507692d9c80c197201dabcd9e403b99dd36bd2983

See more details on using hashes here.

File details

Details for the file ikaris-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ikaris-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for ikaris-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5f2e8690533214ca1d487be15d8ace41cbff44823583d575f5f20290034eeefd
MD5 47189750439edb22eaa0eed2dec7b429
BLAKE2b-256 d5ebc7e62205ef79723897708970e9400045a0274fab2b461430bbce3b57def0

See more details on using hashes here.

Supported by

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