Skip to content

Latest commit

 

History

History
141 lines (111 loc) · 5.04 KB

CONTRIBUTING.md

File metadata and controls

141 lines (111 loc) · 5.04 KB
Raw

IBM Generative AI Development Guide

Setup the Development Environment

Pre-requisites

  • Python version >= 3.9.
  • Setup a virtual environment (using venv or conda) and activate it.
  • You need to activate this environment every time before you want to make changes to this repository.

Using Venv

python -m venv .venv # Create your Virtual environment
source .venv/bin/activate # Activate and use your virtual environment


# And once you're all done..
deactivate

Fork the official repo

  1. Navigate to https://github.com/IBM/ibm-generative-ai repository.
  2. In the top-right corner of the page, click Fork. Important: DO NOT select 'Copy the DEFAULT branch only' option.
  3. Click Create fork .

Further information on how to fork a GitHub repository is avaiable here.

Clone repo and checkout develop branch

git clone <forked-repository-link>
git checkout develop

Install requirements

Minimal pip version is 22.0.1. Check your pip version with pip --version and if needed run the following command to upgrade pip.

pip install --upgrade "pip>=22.0.1"

Following should install regular package dependencies as well as the dependencies required for development.

pip install -e ".[dev]"

Install pre-commit setup

pre-commit install

Setup your IBM Generative AI token

Login to workbench.res.ibm.com/ and get your IBM Generative AI API key. Then, create a genai/.env and assign the GENAI_KEY value as:

GENAI_KEY=<your key here>

Once done, you and genai can use your key using os.getenv("GENAI_KEY") and you will not have to worry about committing it to GitHub.

Make Changes

Create a branch for making changes

git checkout -b <my_awesome_branch> develop

Important: Note we branched off 'develop' not 'main'

Make your changes and add any unit tests. Run tests as

python -m pytest

Commit Changes and Make a Pull Request

Once you are done making changes, run flake8 for linting and try fixing for as many messages as possible.

flake8 .

Add only specific files to your commit instead of doing something like git commit -am. This is recommended so as not to push unwanted files to the repo.

git add src/xyz.py tests/test_xyz.py

Commit your changes. If your code is not well-formatted then our scripts will format it for you. In that case, you may need to add the files again and commit.

git commit -m <my_commit_message>  ## *NOTE* black should auto-format through hooks.

Push your changes

git push origin HEAD

Raise a pull request from your <my_awesome_branch> in the head repository to the develop branch in the base repository. To do so go to the github page of the repo. The image below shows an example:

image

  • Add a description for your PR.
  • Link any issues.
  • Wait for tests to pass. If they fail then try to fix issues. Get in touch with the core team if needed. They will get back to you for anything that needs to be addressed.

Logging

GenAI uses the standard python logging module for logging debug messages within the module. Unless the consuming application explicitly enables logging, no logging messags from GenAI should appear in stdout or stderr e.g. no print statements, we should also always log to the genai namespace so that logs are easily identifiable.

The python standard logging module is documented here.

Below is an example template file showing how logging can be added to a GenAI class.

# Import the logging module
import logging

# Configure the logger to be named genai.xxx (where xxx is the current file or class)
logger = logging.getLogger(__name__)

logger.debug("This is some debug.")
logger.info("This is some info.")
logger.warning("This is a warning.")
logger.error("This is an error.")
logger.critical("This is a critial message.")