Skip to content

Commit c1053fe

Browse files
jesszzzzfacebook-github-bot
authored andcommitted
Add missing custom component docs
Summary: Ultimately we want to remove all the docs under https://www.internalfb.com/intern/wiki/TorchX_internal/TorchX and consolidate it all in the staticdocs wiki. This diff moves the info from https://www.internalfb.com/intern/wiki/TorchX_internal/TorchX/Authoring_Components/ into the custom components wiki page. I didn't include which components to try since it includes fb specific components and this isn't a fb-specific page, just added that they should check existing components before trying to create a custom one. Reviewed By: hstonec Differential Revision: D63643250
1 parent f5d25f0 commit c1053fe

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/source/custom_components.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,23 @@ and launch it via two different schedulers.
1919

2020
See the [Quickstart Guide](quickstart.md) for installation and basic usage.
2121

22+
23+
## Builtins
24+
25+
Before writing a custom component, check if any of the builtin components satisfy your needs. TorchX provides a number of builtin components with premade images. You can discover them via:
26+
27+
```sh
28+
torchx builtins
29+
```
30+
31+
You can use these either from the CLI, from a pipeline or programmatically like
32+
you would any other component.
33+
34+
```sh
35+
torchx run utils.echo --msg "Hello :)"
36+
```
37+
38+
2239
## Hello World
2340

2441
Lets start off with writing a simple "Hello World" python app. This is just a
@@ -130,20 +147,3 @@ $ docker push my_app:latest
130147
$ torchx run --scheduler kubernetes my_component.py:greet --image "my_app:latest" --user "your name"
131148
```
132149
<!-- #endmd -->
133-
134-
135-
## Builtins
136-
137-
TorchX also provides a number of builtin components with premade images. You can discover
138-
them via:
139-
140-
```sh
141-
torchx builtins
142-
```
143-
144-
You can use these either from the CLI, from a pipeline or programmatically like
145-
you would any other component.
146-
147-
```sh
148-
torchx run utils.echo --msg "Hello :)"
149-
```

0 commit comments

Comments
 (0)