Skip to content

Latest commit

 

History

History
198 lines (137 loc) · 7.23 KB

CONTRIBUTING.md

File metadata and controls

198 lines (137 loc) · 7.23 KB
Raw

How to Contribute

Getting Started

Building dependencies

The project depends upon the following technologies:

HARDWARE: NVIDIA GPU - Tesla T4, CUDA Version 12.4, Driver Version: 550.54.17 OS: Amazon Linux 2 SOFTWARE: Python, Hugging Face Transformers and Gradio, Plotly Dash,

Building the Project

The following script will install all required dependencies needed for the project:

#!/bin/bash
 
cd /usr/bin/
sudo yum install gcc openssl-devel bzip2-devel libffi-devel zlib-devel -y
sudo yum remove  openssl openssl-devel.x86_64 -y
sudo yum remove  openssl11-1.1.1g openssl11-libs-1.1.1g openssl11-devel-1.1.1g -y
sudo yum install openssl11-1.1.1g openssl11-libs-1.1.1g openssl11-devel-1.1.1g -y
sudo yum install git-lfs -y
sudo yum install libffi-devel -y
sudo yum install bzip2-devel -y
sudo yum install xz-devel -y
sudo wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
sudo tar xzf Python-3.11.7.tgz
cd Python-3.11.7
sudo ./configure  --enable-optimizations
sudo make altinstall
python3.11 -V
sudo rm -f /opt/Python-3.11.7 .tgz

Workflow and Branching

We follow the GitHub Flow Workflow

  1. Fork the project
  2. Check out the main branch
  3. Create a feature branch
  4. Write code and tests for your change
  5. From your branch, make a pull request against oit_aie/aie_demo_playground/main
  6. Work with repo maintainers to get your change reviewed
  7. Wait for your change to be pulled into oit_aie/aie_demo_playground/main
  8. Delete your feature branch

Coding Style and Linters

This project adheres to PEP8 rules and guidelines whenever possible when accepting new contributions of Python code. Although, there are good reasons to ignore particular guidelines in particular situations. Further information on PEP8 can be found at https://peps.python.org/pep-0008/.

This project also uses pylint as the main linter for the moment and employs pylint checks upon new pull requests into protected branches. Python code quality checks are extremely useful for lowering the cost of maintenence of Python projects. Further information on Pylint can be found at https://pylint.readthedocs.io/en/latest/.

Writing Issues

When creating an issue please try to adhere to the following format:

module-name: One line summary of the issue (less than 72 characters)

### Expected behavior

As concisely as possible, describe the expected behavior.

### Actual behavior

As concisely as possible, describe the observed behavior.

### Steps to reproduce the behavior

List all relevant steps to reproduce the observed behavior.

Policies

Open Source Policy

We adhere to the CMS Open Source Policy. If you have any questions, just shoot us an email.

Security and Responsible Disclosure Policy

Submit a vulnerability: Vulnerability reports can be submitted through Bugcrowd. Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.

For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see SECURITY.md.

Public domain

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication as indicated in LICENSE.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.