An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
For guided demos and basics walkthroughs, check out the following links:
codeflare-sdk
by using the codeflare_sdk.copy_demo_nbs()
functionFull documentation can be found here
Can be installed via pip
: pip install codeflare-sdk
Please see our CONTRIBUTING.md for detailed instructions.
It is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases
The following instructions apply when doing release manually. This may be required in instances where the automation is failing.
pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs -type f -name "*.html" -exec bash -c "echo '' >> {}" \;
(it is possible to install pdoc using the following command poetry install --with docs
)poetry build
poetry config pypi-token.pypi API_TOKEN
poetry publish
cd custom-nb-image
export tag=TAG
podman build --build-arg SDK_VERSION=<version> -t quay.io/project-codeflare/notebook:${tag} .
podman login quay.io
podman push quay.io/project-codeflare/notebook:${tag}
podman push quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:stable