|
| 1 | +# Controlling Access to Models or Datasets in the Enterprise App |
| 2 | + |
| 3 | +Administrators may control which public Models and Datasets are made |
| 4 | +available to users in the Enterprise App via an **allowlist of licenses** |
| 5 | +or an **allowlist of names**. |
| 6 | + |
| 7 | +Set any of the following Enterprise |
| 8 | +[Secrets](https://docs.voxel51.com/enterprise/secrets.html#fiftyone-enterprise-secrets) |
| 9 | +to configure allowlists. Each accepts a comma-separated list. |
| 10 | + |
| 11 | +| Secret | Effect | |
| 12 | +|-----------------------------------------|---------------------------------------------------------------| |
| 13 | +| `FIFTYONE_ZOO_ALLOWED_MODEL_LICENSES` | Include only models distributed under one of these licenses | |
| 14 | +| `FIFTYONE_ZOO_ALLOWED_DATASET_LICENSES` | Include only datasets distributed under one of these licenses | |
| 15 | +| `FIFTYONE_ZOO_ALLOWED_MODEL_NAMES` | Include only these specific models | |
| 16 | +| `FIFTYONE_ZOO_ALLOWED_DATASET_NAMES` | Include only these specific datasets | |
| 17 | + |
| 18 | +## Setting the secrets |
| 19 | + |
| 20 | +An admin adds these in the Enterprise App under **Settings > Secrets**: |
| 21 | + |
| 22 | +1. Click **Add secret**. |
| 23 | +2. Enter the **Key** (upper snake case, e.g. `FIFTYONE_ZOO_ALLOWED_MODEL_LICENSES`). |
| 24 | +3. Enter the **Value** (the comma-separated list). |
| 25 | + |
| 26 | +## Examples |
| 27 | + |
| 28 | +Restrict to permissively licensed models and datasets only: |
| 29 | + |
| 30 | +| Key | Value | |
| 31 | +|-----------------------------------------|--------------------------| |
| 32 | +| `FIFTYONE_ZOO_ALLOWED_MODEL_LICENSES` | `MIT,Apache 2.0` | |
| 33 | +| `FIFTYONE_ZOO_ALLOWED_DATASET_LICENSES` | `CC-BY-SA-3.0,CC-BY-4.0` | |
| 34 | + |
| 35 | +Expose only an explicit, vetted set of entries: |
| 36 | + |
| 37 | +| Key | Value | |
| 38 | +|--------------------------------------|--------------------------------------------------------------------| |
| 39 | +| `FIFTYONE_ZOO_ALLOWED_MODEL_NAMES` | `clip-vit-base32-torch,zero-shot-classification-transformer-torch` | |
| 40 | +| `FIFTYONE_ZOO_ALLOWED_DATASET_NAMES` | `quickstart,coco-2017` | |
| 41 | + |
| 42 | +## Discovering available models and datasets |
| 43 | + |
| 44 | +The following FiftyOne CLI commands can be used to discover Models and |
| 45 | +Datasets available in the FiftyOne Zoo. |
| 46 | + |
| 47 | +```shell |
| 48 | +fiftyone zoo models list |
| 49 | +fiftyone zoo datasets list |
| 50 | +``` |
| 51 | + |
| 52 | +The output includes each entry's license, which is the value you match |
| 53 | +against with the `_LICENSES` variables above. |
| 54 | + |
| 55 | +## See also |
| 56 | + |
| 57 | +- Model Zoo documentation: <https://docs.voxel51.com/model_zoo/index.html> |
| 58 | +- FiftyOne Enterprise Secrets: <https://docs.voxel51.com/enterprise/secrets.html> |
0 commit comments