Skip to content

Commit

Permalink
Add missing custom component docs
Browse files Browse the repository at this point in the history
Differential Revision: D63643250

Pull Request resolved: #963
  • Loading branch information
jesszzzz authored Oct 9, 2024
1 parent 011afdc commit 8aabb7f
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/source/custom_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@ and launch it via two different schedulers.

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


## Builtins

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:

```sh
torchx builtins
```

You can use these either from the CLI, from a pipeline or programmatically like
you would any other component.

```sh
torchx run utils.echo --msg "Hello :)"
```


## Hello World

Lets start off with writing a simple "Hello World" python app. This is just a
Expand Down Expand Up @@ -130,20 +147,3 @@ $ docker push my_app:latest
$ torchx run --scheduler kubernetes my_component.py:greet --image "my_app:latest" --user "your name"
```
<!-- #endmd -->


## Builtins

TorchX also provides a number of builtin components with premade images. You can discover
them via:

```sh
torchx builtins
```

You can use these either from the CLI, from a pipeline or programmatically like
you would any other component.

```sh
torchx run utils.echo --msg "Hello :)"
```

0 comments on commit 8aabb7f

Please sign in to comment.