Skip to main content

eazyml-image-xai provides APIs for explainable AI (XAI)

Project description

EazyML Responsible-AI: Image XAI

Python PyPI package Code Style

EazyML

This package focuses on segmentation prediction, explainability, active learning and online learning for image dataset.

Features

  • Active learning focuses on reducing the amount of labeled data required to train the model while maximizing performance, making it particularly useful when labeling data is expensive or time-consuming. By prioritizing uncertain or diverse examples, active learning accelerates model improvement and enhances efficiency.
  • Online learning is a machine learning approach where models are trained incrementally as data becomes available, rather than using a fixed, pre-existing dataset. This method is well-suited for dynamic environments, enabling real-time updates and adaptability to new patterns or changes in data streams.

Installation

User installation

The easiest way to install Image XAI is using pip:

pip install -U eazyml-xai-image

Dependencies

EazyML Image XAI requires :

  • tensorflow
  • segmentation-models==1.0.1
  • lime
  • opencv-python
  • flask
  • pyyaml

Usage

It provides following apis :

  1. ez_image_active_learning : This API sorts test images based on explainability scores for the model’s predictions. If a “query count” is specified in the options, it returns the indices and corresponding scores for that number of inputs.

    ez_image_active_learning(
            filenames=['..', '..'],
            model_path='path_of_model',
            predicted_filenames=['path_of_model_prediction_file_names'],
            options={
                "query_count": 10,
                "training_data_path": "path/to/training/data.csv",
                "score_strategy": "weighted-moments",
                "al_strategy": "pool-based",
                "xai_strategy": "gradcam",
                "gradcam_layer": "layer_name",
                "model_num": "1"
            }
        )
    
  2. ez_image_model_evaluate : This API validates a model using provided data and returns the model evaluation.

    ez_image_model_evaluate(
            validation_data_path='path_of_new_data_for_validation',
            model_path='path_of_model',
            options={
                "required_functions": {
                    "loss_fn": '...',
                    "metric_fns": '...',
                    "input_preprocess_fn": '',
                    "label_preprocess_fn": '',
                    "output_process_fn": ''
                    },
                "batch_size": 32,
                "log_file": "path/to/log/file"
            })
    
  3. ez_image_online_learning : This API updates a given model using new training data and saves the updated model. The update process adapts based on the Online Learning strategy or optimizes performance on provided validation data.

    ez_image_online_learning(
            validation_data_path='path_of_new_data_for_validation',
            model_path='path_of_model',
            options={
                "required_functions": {
                    "loss_fn": '...',
                    "metric_fns": '...',
                    "input_preprocess_fn": '',
                    "label_preprocess_fn": '',
                    "output_process_fn": ''
                },
                "batch_size": 32,
                "log_file": "path/to/log/file"
            }
        )
    
  4. ez_xai_image_explain : This API provides confidence scores and image explanations for model predictions. It can process a single image or multiple images, returning explanations for all predictions.

    ez_xai_image_explain(
            filenames=['..', '..'],
            model_path='path_of_model',
            predicted_filenames=['path_of_model_prediction_file_names'],
            options={
                "training_data_path": "...",
                "score_strategy": "weighted-moments",
                "xai_strategy": "gradcam",
                "xai_image_path": "...",
                "gradcam_layer": "layer_name",
                "model_num": "1",
                "required_functions": {...}
            }
        )
    

You can find more information in the documentation.

Useful links, other packages from EazyML family

  • Documentation

  • Homepage

  • If you have questions or would like to discuss a use case, please contact us here

  • Here are the other packages from EazyML suite:

    • eazyml-automl: eazyml-automl provides a suite of APIs for training, optimizing and validating machine learning models with built-in AutoML capabilities, hyperparameter tuning, and cross-validation.
    • eazyml-data-quality: eazyml-data-quality provides APIs for comprehensive data quality assessment, including bias detection, outlier identification, and drift analysis for both data and models.
    • eazyml-counterfactual: eazyml-counterfactual provides APIs for optimal prescriptive analytics, counterfactual explanations, and actionable insights to optimize predictive outcomes to align with your objectives.
    • eazyml-insight: eazyml-insight provides APIs to discover patterns, generate insights, and mine rules from your datasets.
    • eazyml-xai: eazyml-xai provides APIs for explainable AI (XAI), offering human-readable explanations, feature importance, and predictive reasoning.
    • eazyml-xai-image: eazyml-xai-image provides APIs for image explainable AI (XAI).

License

This project is licensed under the Proprietary License.


Maintained by EazyML
© 2025 EazyML. All rights reserved.

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

eazyml-xai-image-0.0.45.tar.gz (44.8 MB view details)

Uploaded Source

Built Distribution

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

eazyml_xai_image-0.0.45-py2.py3-none-any.whl (45.5 MB view details)

Uploaded Python 2Python 3

File details

Details for the file eazyml-xai-image-0.0.45.tar.gz.

File metadata

  • Download URL: eazyml-xai-image-0.0.45.tar.gz
  • Upload date:
  • Size: 44.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for eazyml-xai-image-0.0.45.tar.gz
Algorithm Hash digest
SHA256 1e988914cef3a3bc5c6ce4b11259e9674c65d1cda6784fc91b98cbfb5ac0e916
MD5 a58491313baed8d6b605b0daffe22303
BLAKE2b-256 fa82628ecc680f7db596db8577a8d15154850b616389c062eacf3ac2d9bf95f8

See more details on using hashes here.

File details

Details for the file eazyml_xai_image-0.0.45-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for eazyml_xai_image-0.0.45-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8b0816776d05ef26c60473b3f0ff476daf7ffd5c220691242f1dc5f501ea5fa2
MD5 a60c858c26e5b06140dff5729b167203
BLAKE2b-256 990d2be105739a10ee686b999e164c94ca0e544cceb946f057fc3012572f2fc9

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