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.2.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.2-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ikaris-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 e3648e306cc37f576dee9b43641f50c5cbebf50557093139a91dee9417f99fb7
MD5 bd6f13fa540005ebe0f50ee26bfcfa89
BLAKE2b-256 aa68158a43720395b003330ea757e34aa785753267197c1485291d925a630f27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ikaris-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47dc0b0425a27502caffdd98f76fc71ee5719efb03e6799024e23e41c60b47ad
MD5 f24e7d9465ad107f5543068b7981b4f4
BLAKE2b-256 02c1e0aa017c521453c5d838d43184262501b37cf486a2cd487fbfe9a5d86a68

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