Skip to content

aiverify-foundation/aiverify-developer-tools

Repository files navigation

Introduction

Welcome to AI Verify Developer Tools! This repository provides templates to quickly create a test plugin compatible with AI Verify Toolkit. The v2.x branch of this repository should be used to create plugins for AI Verify Toolkit version v2.x. Currently, the v2.x branch is under development, but we have released an alpha version of aiverify-test-engine that provides most of the primitives required to create a plugin. Refer to the algorithm template readme for more information on how to create a plugin with a cookiecutter template.

This document provides important notices and information about the project that contributors and users should be aware of. Please take the time to read through this document thoroughly.

AI Verify

AI Verify is currently live here. AI Verify is launched under the AI Verify Foundation, a subsidiary under the IMDA.

AI Verify is an AI governance testing framework and software toolkit that validates the performance of AI systems against a set of internationally recognised principles through standardised tests. AI Verify is consistent with international AI governance frameworks such as those from European Union, OECD and Singapore.

It is a single integrated toolkit that operates within an enterprise environment. It can perform technical tests on common supervised learning classification and regression models for most tabular and image datasets. It however does not define AI ethical standards and does not guarantee that any AI system tested will be free from risks or biases or is completely safe.

Installing AI Verify

AI Verify v2.x branch is under development. To install the alpha version of aiverify-test-engine, download from pypi using the following command:

pip install aiverify-test-engine==2.0.0a1

User Guide

Learn how you may utilise AI Verify effectively here.

Developer Guide

Learn how you can utilise the developer tools effectively to contribute to the project here.

Contributing Guidelines

We encourage contributions from the community to help improve this project. Before contributing, please read our Contributing Guidelines to understand the process and expectations.

Issue Tracker

Found a bug or have a feature request? Please report it on our issue tracker. We appreciate your feedback and contributions to making this project better. Make sure to adhere to the designated format as provided in the contributing guidelines.

Documentation

Comprehensive documentation is available for your reference. It includes installation and setup instructions, user guides, and other relevant information. Please refer to the documentation before opening an issue or asking for support.

License

This project is released under the Apache 2.0 license, which can be found under the project's license file. By contributing to this project, you agree to release your contributions under the same license. Please ensure that you are familiar with the license terms. You may find a list of the licenses used by dependencies and any other material used by this project there too.

Support

If you have any questions or need assistance, please check the project discussions or issue tracker for existing threads. If you cannot find a resolution, feel free to create a new discussion or issue, or contact us if you require assistance.

Thank you for your interest in AI Verify, and we look forward to your contributions!

Notice

AI Verify
Copyright 2023 AI Verify Foundation

This product includes software developed under the AI Verify Foundation.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.