Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions examples/brightness/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,22 @@ to install on your host but the CLI and Docker.

```sh
cd examples/brightness
reactor build
reactor build --no-dockerfile
reactor run
```

The build is automatic: `reactor build` renders the image from `reactor.yaml`'s
`build:` block — no Dockerfile to write or maintain. `build.runtime_version`
pins the `reactor-runtime` release the image installs; bump it there to
`--no-dockerfile` renders the image from `reactor.yaml`'s `build:` block — no
Dockerfile to write or maintain. `build.runtime_version` must match the
`reactor-runtime==<version>` pin in `requirements.txt`; bump both together to
upgrade.

`reactor run` reuses the image `reactor build` produced (it builds one on first
run if none exists), then serves WebRTC signaling on `http://localhost:8080`.
Rebuild after editing anything baked into the image:
run if none exists, so pass `--no-dockerfile` there too), then serves WebRTC
signaling on `http://localhost:8080`. Rebuild after editing anything baked
into the image:

```sh
reactor build && reactor run
reactor build --no-dockerfile && reactor run
```

Connect a client from the [Reactor Sandbox](https://reactor-sandbox.vercel.app/)
Expand Down
2 changes: 2 additions & 0 deletions examples/brightness/reactor.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
$schema: reactor/v1
apiVersion: v1beta
kind: VideoModel

# `reactor build` / `reactor run` read this file: `model:` describes the model,
# `runtime:` names the class to serve, and `build:` defines the image every
Expand Down
12 changes: 6 additions & 6 deletions examples/brightness/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Python dependencies installed into the model image, in one pass alongside
# the runtime, so a version conflict between them fails the build instead of
# surfacing at model load.
# Python dependencies installed into the model image, in one pip pass, so a
# version conflict between them fails the build instead of surfacing at
# model load.
#
# reactor-runtime does not belong here: reactor.yaml's build.runtime_version
# pins the release the image installs, and stating it twice is how the two
# come to disagree.
# reactor-runtime is the runtime itself. Its version is pinned here; bump
# this line to upgrade, and reactor.yaml's build.runtime_version to match.
reactor-runtime==3.2.4

# Pillow draws the client-set caption over each frame. Must be >=10.1: the
# scalable default font (ImageFont.load_default(size=...)) that keeps the caption
Expand Down
15 changes: 8 additions & 7 deletions examples/echo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,22 @@ to install on your host but the CLI and Docker.

```sh
cd examples/echo
reactor build
reactor build --no-dockerfile
reactor run
```

The build is automatic: `reactor build` renders the image from `reactor.yaml`'s
`build:` block — no Dockerfile to write or maintain. `build.runtime_version`
pins the `reactor-runtime` release the image installs; bump it there to
`--no-dockerfile` renders the image from `reactor.yaml`'s `build:` block — no
Dockerfile to write or maintain. `build.runtime_version` must match the
`reactor-runtime==<version>` pin in `requirements.txt`; bump both together to
upgrade.

`reactor run` reuses the image `reactor build` produced (it builds one on first
run if none exists), then serves WebRTC signaling on `http://localhost:8080`.
Rebuild after editing anything baked into the image:
run if none exists, so pass `--no-dockerfile` there too), then serves WebRTC
signaling on `http://localhost:8080`. Rebuild after editing anything baked
into the image:

```sh
reactor build && reactor run
reactor build --no-dockerfile && reactor run
```

Connect a client from the [Reactor Sandbox](https://reactor-sandbox.vercel.app/)
Expand Down
2 changes: 2 additions & 0 deletions examples/echo/reactor.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
$schema: reactor/v1
apiVersion: v1beta
kind: VideoModel

# `reactor build` / `reactor run` read this file: `model:` describes the model,
# `runtime:` names the class to serve, and `build:` defines the image every
Expand Down
12 changes: 6 additions & 6 deletions examples/echo/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Python dependencies installed into the model image, in one pass alongside
# the runtime, so a version conflict between them fails the build instead of
# surfacing at model load.
# Python dependencies installed into the model image, in one pip pass, so a
# version conflict between them fails the build instead of surfacing at
# model load.
#
# reactor-runtime does not belong here: reactor.yaml's build.runtime_version
# pins the release the image installs, and stating it twice is how the two
# come to disagree.
# reactor-runtime is the runtime itself. Its version is pinned here; bump
# this line to upgrade, and reactor.yaml's build.runtime_version to match.
reactor-runtime==3.2.4

# OpenCV powers the video effects. Must be >=4.10: the runtime ships numpy 2.x,
# and only opencv-python(-headless) 4.10+ is built against the numpy 2 ABI. The
Expand Down