Skip to content

Commit 2cc99dc

Browse files
neverettneverett
authored
Add basic template that uses ImageSpec (#43)
* add basic imagespec example Signed-off-by: nikki everett <nikki@union.ai> * use latest base image and python 3.11 Signed-off-by: nikki everett <nikki@union.ai> * rename to distinguish from basic dockerfile template Signed-off-by: nikki everett <nikki@union.ai> * update repo README Signed-off-by: nikki everett <nikki@union.ai> * update imagespec Signed-off-by: nikki everett <nikki@union.ai> * comment out imagespec definition, make linter fixes Signed-off-by: nikki everett <nikki@union.ai> * update steps Signed-off-by: nikki everett <nikki@union.ai> * make documentation more procedural Signed-off-by: nikki everett <nikki@union.ai> * small edits Signed-off-by: nikki everett <nikki@union.ai> * remove docker section Signed-off-by: nikki everett <nikki@union.ai> * add hello world template Signed-off-by: nikki everett <nikki@union.ai> * rename directory to make it clear this is a template, remove unnecessary requirements, small edits to example python script Signed-off-by: nikki everett <nikki@union.ai> * this has been renamed Signed-off-by: nikki everett <nikki@union.ai> * update with hello world template Signed-off-by: nikki everett <nikki@union.ai> * use cookiecutter for hello world template Signed-off-by: nikki everett <nikki@union.ai> * use cookiecutter for basic imagespec template Signed-off-by: nikki everett <nikki@union.ai> * small edits Signed-off-by: nikki everett <nikki@union.ai> * add note about default docker image Signed-off-by: nikki everett <nikki@union.ai> * fix hello-world template name Signed-off-by: nikki everett <nikki@union.ai> * update comments Signed-off-by: nikki everett <nikki@union.ai> * rename image definition Signed-off-by: nikki everett <nikki@union.ai> * rename for consistency Signed-off-by: nikki everett <nikki@union.ai> --------- Signed-off-by: nikki everett <nikki@union.ai>
1 parent f0a5f02 commit 2cc99dc

10 files changed

Lines changed: 325 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
In this repository you'll find a collection of [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) templates for making [Flyte](https://github.com/flyteorg/flyte) projects.
22

3-
We use cookiecutter's ability to define [multiple templates to be defined in the same repository](https://cookiecutter.readthedocs.io/en/latest/advanced/directories.html). Each cookiecutter template is defined in a separate directory, e.g. the template used in Flyte's [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) guide lives in a directory called `simple-example`.
3+
We use cookiecutter's ability to define [multiple templates to be defined in the same repository](https://cookiecutter.readthedocs.io/en/latest/advanced/directories.html). Each cookiecutter template is defined in a separate directory, e.g. the template used in Flyte's [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) guide lives in a directory called `basic-template-imagespec`.
44

5-
This project includes a script `docker_build.sh` that you can use to build a
6-
Docker image for your Flyte project.
5+
## Images
6+
7+
Compiled images for all templates can be found in our [ghcr.io registry](https://github.com/flyteorg/flytekit-python-template/pkgs/container/flytekit-python-template)
8+
9+
### ImageSpec vs Dockerfile
10+
11+
Flytekit uses the `basic-template-imagespec` template by default when you initialize a new project with `pyflyte init`. That template uses [ImageSpec](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/customizing_dependencies/image_spec.html#image-spec-example), which builds Docker images without a Dockerfile, so doesn't contain a Dockerfile or `docker-build.sh` script.
12+
13+
However, some templates in this repository contain a Dockerfile and `docker-build.sh` script that you can use to build a Docker image for your Flyte project:
714

815
```
916
# help
@@ -16,13 +23,12 @@ Docker image for your Flyte project.
1623
./docker_build.sh -p {{ cookiecutter.project_name }} -r <REGISTRY> -v <VERSION>
1724
```
1825

19-
## Images
20-
Compiled Images for all templates can be found in our [ghcr.io registry](https://github.com/flyteorg/flytekit-python-template/pkgs/container/flytekit-python-template)
26+
**Note:** You should only use `docker-build.sh` script to build a Docker image for a Flyte project that contains a Dockerfile.
2127

2228
## Usage
2329

24-
Each template can be rendered by specifying the `--directory` flag to cookiecutter. For example, in order to generate a project using the `simple-example` template run:
30+
Each template can be rendered by specifying the `--directory` flag to cookiecutter. For example, in order to generate a project using the `basic-template-imagespec` template, run:
2531

26-
$ cookiecutter https://github.com/flyteorg/flytekit-python-template.git --directory="simple-example"
32+
$ cookiecutter https://github.com/flyteorg/flytekit-python-template.git --directory="basic-template-imagespec"
2733

28-
This should prompt for a few variables that will be used to setup the project.
34+
This should prompt for a few variables that will be used to set up the project.

‎basic-template-imagespec/cookiecutter.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"project_name": "Basic template ImageSpec"
3+
}

‎basic-template-imagespec/{{cookiecuter.project_name}}/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎basic-template-imagespec/{{cookiecuter.project_name}}/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# {{ cookiecutter.project_name }}
2+
3+
A template for the recommended layout of a Flyte enabled repository for code written in python using [flytekit](https://docs.flyte.org/projects/flytekit/en/latest/).
4+
5+
## Usage
6+
7+
To get up and running with your Flyte project, we recommend following the
8+
[Flyte getting started guide](https://docs.flyte.org/en/latest/getting_started.html).

‎basic-template-imagespec/{{cookiecuter.project_name}}/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
flytekit>=1.5.0

‎basic-template-imagespec/{{cookiecuter.project_name}}/workflows/__init__.py‎

Whitespace-only changes.

‎basic-template-imagespec/{{cookiecuter.project_name}}/workflows/example.py‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
"""A basic Flyte project template that uses ImageSpec"""
2+
3+
import typing
4+
from flytekit import task, workflow
5+
6+
7+
"""
8+
ImageSpec is a way to specify a container image configuration without a
9+
Dockerfile. To use ImageSpec:
10+
1. Add ImageSpec to the flytekit import line.
11+
2. Uncomment the ImageSpec definition below and modify as needed.
12+
3. If needed, create additional image definitions.
13+
4. Set the container_image parameter on tasks that need a specific image, e.g.
14+
`@task(container_image=basic_image)`. If no container_image is specified,
15+
flytekit will use the default Docker image at
16+
https://github.com/flyteorg/flytekit/pkgs/container/flytekit.
17+
18+
For more information, see the
19+
`ImageSpec documentation <https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/customizing_dependencies/image_spec.html#image-spec-example>`__.
20+
"""
21+
22+
# image_definition = ImageSpec(
23+
# name="basic-example", # rename this to your docker image name
24+
# # the base image that flytekit will use to build your image
25+
# base_image="ghcr.io/flyteorg/flytekit:py3.11-1.10.2",
26+
# packages=["flytekit>=1.6.0"], # packages to add to the base image
27+
# registry="ghcr.io/unionai-oss", # registry your image will be pushed to
28+
# # the python version; optional if not different from the base image
29+
# python_version="3.11"
30+
# )
31+
32+
33+
@task()
34+
def say_hello(name: str) -> str:
35+
"""A simple Flyte task to say "Hello".
36+
37+
The @task decorator allows Flyte to use this function as a Flyte task,
38+
which is executed as an isolated, containerized unit of compute.
39+
"""
40+
return f"Hello, {name}!"
41+
42+
43+
@task()
44+
def greeting_length(greeting: str) -> int:
45+
"""A task the counts the length of a greeting."""
46+
return len(greeting)
47+
48+
49+
@workflow
50+
def wf(name: str = "world") -> typing.Tuple[str, int]:
51+
"""Declare workflow called `wf`.
52+
53+
The @workflow decorator defines an execution graph that is composed of
54+
tasks and potentially sub-workflows. In this simple example, the workflow
55+
is composed of just one task.
56+
57+
There are a few important things to note about workflows:
58+
- Workflows are a domain-specific language (DSL) for creating execution
59+
graphs and therefore only support a subset of Python's behavior.
60+
- Tasks must be invoked with keyword arguments
61+
- The output variables of tasks are Promises, which are placeholders for
62+
values that are yet to be materialized, not the actual values.
63+
"""
64+
greeting = say_hello(name=name)
65+
greeting_len = greeting_length(greeting=greeting)
66+
return greeting, greeting_len
67+
68+
69+
if __name__ == "__main__":
70+
# Execute the workflow by invoking it like a function and passing in
71+
# the necessary parameters
72+
print(f"Running wf() {wf(name='passengers')}")

‎hello-world/cookiecutter.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"project_name": "Hello world"
3+
}

‎hello-world/{{cookiecutter.project_name}}/example.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""A basic Flyte example"""
2+
3+
from flytekit import task, workflow
4+
5+
6+
@task
7+
def say_hello(name: str) -> str:
8+
return f"Hello, {name}!"
9+
10+
11+
@workflow
12+
def hello_world_wf(name: str = 'world') -> str:
13+
res = say_hello(name=name)
14+
return res
15+
16+
17+
if __name__ == "__main__":
18+
# Execute the workflow by invoking it like a function and passing in
19+
# the necessary parameters
20+
print(f"Running wf() {hello_world_wf(name='passengers')}")

‎templates.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
{"template_name": "mnist-training", "workflow_name": "mnist_workflow_cpu"},
33
{"template_name": "mnist-training", "workflow_name": "mnist_workflow_gpu"},
44
{"template_name": "simple-example", "workflow_name": "wf"},
5-
{"template_name": "wine-classification", "workflow_name": "training_workflow"}
5+
{"template_name": "wine-classification", "workflow_name": "training_workflow"},
6+
{"template_name": "basic-template-imagespec", "workflow_name": "wf"},
7+
{"template_name": "hello-world", "workflow_name": "hello_world_wf"}
68
]

0 commit comments

Comments
 (0)