Anyscale Starter Templates

⚠️ DEPRECATION NOTICE

This repository is being deprecated.

• For existing templates: Consider moving them to the Ray repo at https://github.com/ray-project/ray/tree/master/doc/source/templates
• For new templates: Create templates directly in the Ray repo instead of this repository

These templates are a set of minimal examples & tutorials for customers to run on the anyscale platform.

Contributing Guide

If the template is generic to Ray & Ray libraries, please consider adding the template in: https://github.com/ray-project/ray/tree/master/doc/source/templates

To setup the environment:

1. Install pre-commit pip install pre-commit
2. Install the git hook scripts pre-commit install

To add a template:

1. Add your template as a directory under templates/<your-template-name>

   For example:

   templates/my-awesome-template
       <name-of-your-template>/
           README.md
           <name-of-your-template>.ipynb/py
   

   Your template does not need to be a Jupyter notebook. It can also be presented as a Python script.

   All templates MUST have a README.md or a README.ipynb file.

2. Add your compute configuration under configs/<your-template-name> (for both AWS and GCE).

3. Update the product repo backend/workspace-templates.yaml to point to the new template added here after being merged.