Skip to content
This repository has been archived by the owner on Mar 28, 2022. It is now read-only.

Commit

Permalink
Add Example Models page (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
brannondorsey committed Aug 6, 2019
1 parent 42a5fa2 commit e147ddf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/source/example_models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Example Models

In order to better understand the process of porting a model to Runway, we recommend checking out the source code for some of the models that have already been ported. All models published by the runway organization are open source, as well as many of the models contributed by our community.

* [Image-Super-Resolution](https://github.com/agermanidis/image-super-resolution): A very simple image upscaling model that gives a good overview of the role of [`runway_model.py`](https://github.com/agermanidis/image-super-resolution/blob/master/runway_model.py).
* [StyleGAN](https://github.com/agermanidis/stylegan): A good example of loading a model checkpoint as well as using the [vector data type](ui_components.html#vector).
* [SPADE-COCO](https://github.com/agermanidis/spade-coco): A good example of the [segmentation data type](ui_components.html#segmentation).
* [DeepLabV3](https://github.com/agermanidis/DeepLabV3): A good example of multiple `@command()` functions and [conditional build steps](https://github.com/agermanidis/DeepLabV3/blob/master/runway.yml) depending on GPU and CPU build environments. Also a very simple model to get started with.
* [Places365](https://github.com/maybay21/model_places365): A good example of a basic image classification task and use of [the text data type](ui_components.html#text) for output.
* [3DDFA](https://github.com/maybay21/3DDFA): A good example of dealing with 3D data as images. We plan to add more features for handling true 3D data.
3 changes: 2 additions & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ build_steps:
- pip install -r requirements.txt
```

Continue on to the [Runway YAML reference page](runway_yaml_file.html) to learn more about the possible configuration values supported by the `runway.yml` file.
Continue on to the [Runway YAML reference page](runway_yaml_file.html) to learn more about the possible configuration values supported by the `runway.yml` file, or hop over to the [Example Models](example_models.html) page to check out the source code for some of the models that have already been ported to Runway.

<!-- http://www.sphinx-doc.org/en/1.5/markup/toctree.html -->
```eval_rst
Expand All @@ -107,5 +107,6 @@ Continue on to the [Runway YAML reference page](runway_yaml_file.html) to learn
Data Types <data_types>
Exceptions <exceptions>
UI Components <ui_components>
Example Models <example_models>
CHANGELOG <https://github.com/runwayml/model-sdk/blob/master/CHANGELOG.md>
```

0 comments on commit e147ddf

Please sign in to comment.