Skip to content

Commit fc83b07

Browse files
committed
Adding final touches
1 parent a61e88e commit fc83b07

2 files changed

Lines changed: 25 additions & 5 deletions

File tree

docker/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,11 @@ FiftyOne Enterprise supports three plugin modes: **Builtin**, **Shared**, and
307307
**Dedicated**. Each offers different trade-offs in isolation, flexibility, and
308308
resource management.
309309

310+
> :warning: To run core FiftyOne methods like computing embeddings, you will
311+
> need to update your plugin image to contain torch. You can use one of the
312+
> images we publish like `voxel51/fiftyone-app-torch` or
313+
> `voxel51/fiftyone-teams-cv-full`.
314+
310315
### :small_blue_diamond: 1. Builtin Plugins Only (Default)
311316

312317
This is the default configuration. It enables only the plugins shipped with the

docker/docs/known-issues.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ connection.
3636

3737
## Delegated Operators: Troubleshooting
3838

39-
### 🧠 Handling `DataLoader worker exited unexpectedly` Errors
39+
### :brain: Handling `DataLoader worker exited unexpectedly` Errors
4040

4141
This error often occurs when using Torch-based models that rely on
4242
`torch.multiprocessing`, which utilizes **shared memory (`/dev/shm`)** to
@@ -56,7 +56,7 @@ This can happen in:
5656

5757
---
5858

59-
### 🛠️ Solution: Increase Shared Memory Allocation
59+
### :hammer_and_wrench: Solution: Increase Shared Memory Allocation
6060

6161
To resolve this, increase the shared memory (`shm_size`) available to the
6262
affected service.
@@ -72,18 +72,33 @@ services:
7272
shm_size: "512m"
7373
```
7474
75-
> 🔁 You can adjust the value based on your workload (e.g., `'1g'` for larger
76-
> models).
75+
> :repeat: You can adjust the value based on your workload (e.g., `'1g'` for
76+
> larger models).
7777
7878
If you’re using shared plugins (i.e., plugins running inside `fiftyone-app`),
7979
you may need to apply the same `shm_size` setting to that service instead.
8080

8181
---
8282

83-
### 🔎 Tip
83+
### :mag_right: Tip
8484

8585
To verify shared memory usage and limits inside a container, run:
8686

8787
```bash
8888
docker exec -it <container_name> df -h /dev/shm
8989
```
90+
91+
### :brain: Handling `torch not found` Errors
92+
93+
When trying to run any torch model like `clip-vit-base32-torch` in your
94+
`teams-plugin` or `teams-do` containers, you need to ensure that `torch` is
95+
installed on your system. Otherwise you might see errors like -
96+
97+
```shell
98+
The requested operation requires that 'torch' is installed on your machine.
99+
```
100+
101+
### :hammer_and_wrench: Solution: Update the docker image used in your containers
102+
103+
To address this issue you can use one of the images we publish that contains
104+
torch like `voxel51/fiftyone-app-torch` or `voxel51/fiftyone-teams-cv-full`.

0 commit comments

Comments
 (0)