aiverify icon indicating copy to clipboard operation
aiverify copied to clipboard

Dockerfile fairness metrics toolbox for regression (#347)

Open simin-ong opened this issue 5 months ago • 0 comments

  • Update README.md

  • Dockerfile for regression, minor edits to testing path for pipeline

Description

Added dockerfile to run fairness metrics toolbox for regression Volume mounts to local folders to access data and model files, and to view output/results.json Currently cloning test-engine-core folder to install requirements; in future can pip install test-engine-core

Type of Change

Feat: Allow developers to run algorithm as a docker image

How to Test

After building the image, execute the command to run the existing unit and e2e tests:

docker run --entrypoint python3 aiverify-fairness-metrics-toolbox-for-regression:v2.0.0a1 -m pytest .

Checklist

Please check all the boxes that apply to this pull request using "x":

  • [x] I have tested the changes locally and verified that they work as expected.
  • [x] I have added or updated the necessary documentation (README, API docs, etc.).
  • [x] I have added appropriate unit tests or functional tests for the changes made.
  • [x] I have followed the project's coding conventions and style guidelines.
  • [x] I have rebased my branch onto the latest commit of the main branch.
  • [x] I have squashed or reorganized my commits into logical units.
  • [x] I have added any necessary dependencies or packages to the project's build configuration.
  • [x] I have performed a self-review of my own code.
  • [x] I have read, understood and agree to the Developer Certificate of Origin below, which this project utilises.

Screenshots (if applicable)

image

Additional Notes

[Add any additional information or context that might be relevant to reviewers.]

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
   have the right to submit it under the open source license
   indicated in the file; or

(b) The contribution is based upon previous work that, to the best
   of my knowledge, is covered under an appropriate open source
   license and I have the right under that license to submit that
   work with modifications, whether created in whole or in part
   by me, under the same open source license (unless I am
   permitted to submit under a different license), as indicated
   in the file; or

(c) The contribution was provided directly to me by some other
   person who certified (a), (b) or (c) and I have not modified
   it.

(d) I understand and agree that this project and the contribution
   are public and that a record of the contribution (including all
   personal information I submit with it, including my sign-off) is
   maintained indefinitely and may be redistributed consistent with
   this project or the open source license(s) involved.

simin-ong avatar Oct 03 '24 01:10 simin-ong