Skip to content
Open
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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,18 @@ manage your organization, applications, quotas, and users registered with the Ai
2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage.
3. Both roles can trigger application runs.

#### Inviting and managing users

If you have the Administrator role, you invite colleagues to your organization directly from the Console:

1. Log in to the [Console](https://platform.aignostics.com) and select **Admin** in the sidebar, then open **Members**.
2. At the bottom of the Members page, enter the colleague's email address and assign a role:
- **Member** — a regular user who can run applications and manage their own runs.
- **Admin** — everything a member can do, plus inviting and managing other users.
3. Click **Send**. The colleague receives a signup email from `support@aignostics.com` inviting them to accept the invitation, set a password, and configure two-factor authentication.

The email address must use your organization's official domain (see the registration requirements above). Return to the Members page at any time to review your organization's users and their roles.

### Applications
An application is a fully automated advanced machine learning based workflow composed of one or more specific tasks (e.g. Tissue Quality Control, Tissue Segmentation, Cell Detection, Cell Classification and predictive analysis). Each application is designed for a particular analysis purpose (e.g. Tumor Micro Environment analysis or biomarker scoring). For each application we define input requirements, processing tasks and output formats.

Expand Down
12 changes: 12 additions & 0 deletions docs/partials/README_platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ manage your organization, applications, quotas, and users registered with the Ai
2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage.
3. Both roles can trigger application runs.

#### Inviting and managing users

If you have the Administrator role, you invite colleagues to your organization directly from the Console:

1. Log in to the [Console](https://platform.aignostics.com) and select **Admin** in the sidebar, then open **Members**.
2. At the bottom of the Members page, enter the colleague's email address and assign a role:
- **Member** — a regular user who can run applications and manage their own runs.
- **Admin** — everything a member can do, plus inviting and managing other users.
3. Click **Send**. The colleague receives a signup email from `support@aignostics.com` inviting them to accept the invitation, set a password, and configure two-factor authentication.

The email address must use your organization's official domain (see the registration requirements above). Return to the Members page at any time to review your organization's users and their roles.

### Applications
An application is a fully automated advanced machine learning based workflow composed of one or more specific tasks (e.g. Tissue Quality Control, Tissue Segmentation, Cell Detection, Cell Classification and predictive analysis). Each application is designed for a particular analysis purpose (e.g. Tumor Micro Environment analysis or biomarker scoring). For each application we define input requirements, processing tasks and output formats.

Expand Down
18 changes: 18 additions & 0 deletions docs/partials/_invite_your_team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Invite your team

If you are your organization's **Administrator**, you can invite colleagues onto the Aignostics Platform so they can run analyses too.

> 💡 **Not an administrator?** Skip this section — ask whoever set up your organization's account to invite you.

1. **Open the members page.** Log in to the [Aignostics Console](https://platform.aignostics.com), select **Admin** in the sidebar, then open **Members**.

2. **Add a colleague and choose their role.** At the bottom of the Members page, enter their email address and assign a role:

- **Member** — can run applications and manage their own runs.
- **Admin** — everything a member can do, plus inviting and managing other users.

> ⚠️ The email address must use your organization's own domain — the same domain as yours.

3. **Send the invitation.** Click **Send**. Your colleague receives a signup email from `support@aignostics.com` and completes the same steps you did — see **Sign up for the Aignostics Platform** at the start of this guide.

Return to the Members page any time to review your organization's users and their roles.
3 changes: 3 additions & 0 deletions docs/partials/get_started_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,6 @@ To check system health manually:
```shell
uvx aignostics system health
```

```{include} ../partials/_invite_your_team.md
```
3 changes: 3 additions & 0 deletions docs/partials/get_started_launchpad.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,9 @@ Your slide appears in QuPath with the analysis annotations layered on top — ti

**Congratulations** — you have signed up, installed Launchpad, run your first analysis, and opened the results in QuPath.

```{include} ../partials/_invite_your_team.md
```

## Troubleshooting

<details>
Expand Down
3 changes: 3 additions & 0 deletions docs/partials/get_started_library.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,6 @@ The `download_url` is a signed URL that allows the Aignostics Platform to downlo
To make whole slide images available to the Aignostics Platform, you provide a signed URL the platform can download from. Signed URLs for files in Google Cloud Storage buckets can be generated with `generate_signed_url` ([code](https://github.com/aignostics/python-sdk/blob/main/src/aignostics/platform/_utils.py)).

**You must provide the [required credentials](https://cloud.google.com/docs/authentication/application-default-credentials) for the Google Cloud Storage bucket.**

```{include} ../partials/_invite_your_team.md
```
3 changes: 3 additions & 0 deletions docs/partials/get_started_mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,6 @@ Plugins register themselves via Python entry points; their tools are automatical
## What AI agents can do

Once configured, AI agents can help with platform operations through natural language, using the tools exposed by the SDK and any installed plugins.

```{include} ../partials/_invite_your_team.md
```
Loading