Helper library for creating Runway models
Project description
The Runway Model SDK allows you to port new and existing machine learning models to the Runway platform. With a few lines of code, you can modify your Python model to be used and shared by others on Runway.
Installing
The SDK supports both Python 2.7 and Python 3, but we recommend using Python 3. You can install the module using either pip or pip3 like so:
pip3 install runway-python
Now head over to the sdk docs to learn how to use the Runway Model SDK.
Docs
Reference and documentation for the Runway Model SDK is hosted at sdk.runwayml.com. These docs provide an overview of how to use the SDK to port your own ML models.
The Runway Model Template repo also contains a simple example of how to get started porting a model to Runway.
See the Importing Models into Runway tutorial for a walk-through illustrating how to port a model to Runway.
Developing
If you'd like to contribute to the development of the Runway Python SDK, you can clone and modify this repository by following the instructions below. At the time of this writing the SDK is compatible with Python 2.7 and Python 3, however our developer dependencies requirements-dev.txt
require Python 3.
git clone https://github.com/runwayml/model-sdk runway-model-sdk
cd runway-model-sdk
## optionally use a virtual environment
# virtualenv -p python3 venv && source venv/bin/activate
# install dependencies
python3 setup.py install
# install the dev dependencies
make dev
Building the Docs
The Model SDK documentation is generated from inline source code using docstrings, Sphinx, and a modified Read the Docs HTML theme. The version of Sphinx that we are using (v2.0.1) requires Python 3.
## Create and activate a python3 virtual environment if you need to.
# virtualenv -p python3 venv && source ./venv/bin/activate
# make sure you have the docs dependencies installed
make dev-docs
# build the docs
make docs
Your auto-generated HTML docs should now appear in docs/build/html
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for runway_python-0.0.69-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 888d5d2744e1597d581926fdcc9fccdf0c7f93497ccf1dec03082c6c5f51db31 |
|
MD5 | 9c56000d3a586dd4bea1b65225819823 |
|
BLAKE2b-256 | 3f3f8bce935306a99cc0fe7f39380567b4ad12900cba04c6e4605a67dabce6c4 |