Skip to main content

An optimization tool-kit package utilizing automatic differentiation

Project description

Build Status

codecov

Group 23 Final Project

Members

  • Omead Eftekhari
  • Drew Pendergrass
  • Saul Soto
  • Ryan Liu

Installation

Install our package by running the following command into the bash:

pip install AutoDiffGroup23andMe

Documentation

https://github.com/Group23andMe/cs107-FinalProject/blob/master/docs/documentation.ipynb

Broader Impact

Auto-differentiation is a powerful tool, which powers the optimization capabilities of our package. Although the optimization of purely mathematical functions is not likely to be a cause of concern, the application of these algorithms to real life data has potential to be misused and misinterpretted, especially when this data is biased or the optimizations are used for purposes have negative externalities. We encourage individuals who apply this optimization software to data to evaluate what are some potential causes of bias and to keep algorithmic fairness in mind.

Software Inclusivity

Since this project is our submission to the CS107 final project and its main purpose is to showcase the abilities of auto-differentiation, we would like to keep the master branch of this repo static after submission. However, anyone is welcome to clone this project if they want to build on the code base themselves. We encourage people who clone this repo to also make their extensions open-source, so that others can learn from their code. All the developers of this package used their personal Github to contribute and will receive notifications about any questions or issues, and all of us are happy to help in any way that we can. In the event that this package becomes active, we are committed to reviewing and accepting pull requests anonymously and respectfully. If you feel that your contribution is unfairly ignored, please raise the issue with us. We acknowlege a history of racial and gender-based inequality in software development and will do our best to confront and correct this issue.

We recognize that there may be barriers for certain interested individuals that may not have access to GitHub or Pypi or the necessary resources to clone or run this package on their own computers, in which case we encourage you to utilize free online resources such as Google Colab. A tutorial of how to clone and install packages all on Google Colab/Google Drive is linked here: https://www.kdnuggets.com/2018/02/google-colab-free-gpu-tutorial-tensorflow-keras-pytorch.html/2

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

AutoDiffGroup23andMe-0.0.1.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

AutoDiffGroup23andMe-0.0.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file AutoDiffGroup23andMe-0.0.1.tar.gz.

File metadata

  • Download URL: AutoDiffGroup23andMe-0.0.1.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for AutoDiffGroup23andMe-0.0.1.tar.gz
Algorithm Hash digest
SHA256 813e2be69adee6a22a770d8e2897f98cfab078a153f0638b3feb9026a1609abb
MD5 d36d4ee3402b5c282f495c089d18d7b9
BLAKE2b-256 09f00917b03206ea23cef98f40fefaebf2c56ec09d77534e9b20c51b21b778fc

See more details on using hashes here.

File details

Details for the file AutoDiffGroup23andMe-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: AutoDiffGroup23andMe-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for AutoDiffGroup23andMe-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee74e23d55214b4350080b00b365218485d53b76ad85ad307e36b812d48897d7
MD5 5e8c1b0602c4509dbcebaf638f0b4839
BLAKE2b-256 daa06592114f34c311ba78d3ed866005fcd1a411e32592558af250b65c69eb64

See more details on using hashes here.

Supported by

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