From 72ef3a5939d18f317756270a9a217a15d4a53b5a Mon Sep 17 00:00:00 2001 From: Suzanne Selhorn <sselhorn@gitlab.com> Date: Tue, 24 Sep 2024 15:52:12 +0000 Subject: [PATCH] Adding Self-Hosted Model Deployment to feature list --- .../configure_duo_features.md | 12 +----------- doc/administration/self_hosted_models/index.md | 13 ++----------- .../install_infrastructure.md | 17 ++++------------- .../self_hosted_models/troubleshooting.md | 2 +- .../documentation/styleguide/word_list.md | 11 +++++++++++ doc/user/gitlab_duo/index.md | 10 ++++++++++ 6 files changed, 29 insertions(+), 36 deletions(-) diff --git a/doc/administration/self_hosted_models/configure_duo_features.md b/doc/administration/self_hosted_models/configure_duo_features.md index 9c038477495ab..88277cb45bc2b 100644 --- a/doc/administration/self_hosted_models/configure_duo_features.md +++ b/doc/administration/self_hosted_models/configure_duo_features.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w DETAILS: **Tier:** For a limited time, Premium and Ultimate. In the future, [GitLab Duo Enterprise](../../subscriptions/subscription-add-ons.md). **Offering:** Self-managed -**Status:** Experiment +**Status:** Beta > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12972) in GitLab 17.1 [with a flag](../../administration/feature_flags.md) named `ai_custom_model`. Disabled by default. @@ -18,16 +18,6 @@ FLAG: The availability of this feature is controlled by a feature flag. For more information, see the history. -WARNING: -This feature is considered [experimental](../../policy/experiment-beta-support.md) and is not intended for customer usage outside of initial design partners. We expect major changes to this feature. - -DISCLAIMER: -This page contains information related to upcoming products, features, and functionality. -It is important to note that the information presented is for informational purposes only. -Please do not rely on this information for purchasing or planning purposes. -The development, release, and timing of any products, features, or functionality may be subject to change or delay and remain at the -sole discretion of GitLab Inc. - To configure your GitLab instance to access the available self-hosted models in your infrastructure: 1. Configure the self-hosted model. diff --git a/doc/administration/self_hosted_models/index.md b/doc/administration/self_hosted_models/index.md index baa91ad1c9a73..0740cd795c04f 100644 --- a/doc/administration/self_hosted_models/index.md +++ b/doc/administration/self_hosted_models/index.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w DETAILS: **Tier:** For a limited time, Premium and Ultimate. In the future, [GitLab Duo Enterprise](../../subscriptions/subscription-add-ons.md). **Offering:** Self-managed -**Status:** Experiment +**Status:** Beta > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12972) in GitLab 17.1 [with a flag](../../administration/feature_flags.md) named `ai_custom_model`. Disabled by default. @@ -18,15 +18,6 @@ FLAG: The availability of this feature is controlled by a feature flag. For more information, see the history. -WARNING: -This feature is considered [experimental](../../policy/experiment-beta-support.md) and is not intended for customer usage outside of initial design partners. We expect major changes to this feature. - -DISCLAIMER: -This page contains information related to upcoming products, features, and functionality. -It is important to note that the information presented is for informational purposes only. -Please do not rely on this information for purchasing or planning purposes. -The development, release, and timing of any products, features, or functionality may be subject to change or delay and remain at the sole discretion of GitLab Inc. - When you deploy a self-hosted model, you can: - Manage the end-to-end transmission of requests to enterprise-hosted large @@ -59,7 +50,7 @@ feature. For more information about this offering, see To deploy a self-hosted large language model: -1. [Set up your self-hosted model deployment infrastructure](../../administration/self_hosted_models/install_infrastructure.md) and connect it to your GitLab instance. +1. [Set up your self-hosted model infrastructure](../../administration/self_hosted_models/install_infrastructure.md) and connect it to your GitLab instance. 1. [Configure your GitLab instance to access self-hosted models](../../administration/self_hosted_models/configure_duo_features.md) using instance and group settings. ## Self-hosted models compared to the default GitLab AI vendor architecture diff --git a/doc/administration/self_hosted_models/install_infrastructure.md b/doc/administration/self_hosted_models/install_infrastructure.md index 96bd42d8d8104..1b74238009188 100644 --- a/doc/administration/self_hosted_models/install_infrastructure.md +++ b/doc/administration/self_hosted_models/install_infrastructure.md @@ -1,16 +1,16 @@ --- stage: AI-Powered group: Custom Models -description: Setup your self-hosted model deployment infrastructure +description: Set up your self-hosted model infrastructure info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up your self-hosted model deployment infrastructure +# Set up your self-hosted model infrastructure DETAILS: **Tier:** For a limited time, Premium and Ultimate. In the future, [GitLab Duo Enterprise](../../subscriptions/subscription-add-ons.md). **Offering:** Self-managed -**Status:** Experiment +**Status:** Beta > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12972) in GitLab 17.1 [with a flag](../../administration/feature_flags.md) named `ai_custom_model`. Disabled by default. @@ -18,19 +18,10 @@ FLAG: The availability of this feature is controlled by a feature flag. For more information, see the history. -WARNING: -This feature is considered [experimental](../../policy/experiment-beta-support.md) and is not intended for customer usage outside of initial design partners. We expect major changes to this feature. - -DISCLAIMER: -This page contains information related to upcoming products, features, and functionality. -It is important to note that the information presented is for informational purposes only. -Please do not rely on this information for purchasing or planning purposes. -The development, release, and timing of any products, features, or functionality may be subject to change or delay and remain at the sole discretion of GitLab Inc. - By self-hosting the model, AI Gateway, and GitLab instance, there are no calls to external architecture, ensuring maximum levels of security. -To set up your self-hosted model deployment infrastructure: +To set up your self-hosted model infrastructure: 1. Install the large language model (LLM) serving infrastructure. 1. Configure your GitLab instance. diff --git a/doc/administration/self_hosted_models/troubleshooting.md b/doc/administration/self_hosted_models/troubleshooting.md index eeee10486b41d..1fabf9df24ac3 100644 --- a/doc/administration/self_hosted_models/troubleshooting.md +++ b/doc/administration/self_hosted_models/troubleshooting.md @@ -1,7 +1,7 @@ --- stage: AI-Powered group: Custom Models -description: Troubleshooting tips for deploying self-hosted model deployment +description: Troubleshooting tips for deploying self-hosted models info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index 7c21a3d6eaa2f..e1305d142246e 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -1009,6 +1009,7 @@ the following are the names of GitLab Duo features: - GitLab Duo Merge Request Summary - GitLab Duo Product Analytics - GitLab Duo Root Cause Analysis +- GitLab Duo Self-Hosted Models - GitLab Duo Test Generation - GitLab Duo Vulnerability Explanation - GitLab Duo Vulnerability Resolution @@ -2002,6 +2003,16 @@ Use **self-hosted model** (lowercase) to refer to a language model that's hosted The language model might be an LLM (large language model), but it might not be. +## Self-Hosted Models + +Use title case for the **GitLab Duo Self-Hosted Models** feature. + +On first mention on a page, use **GitLab Duo Self-Hosted Models**. +Thereafter, use **Self-Hosted Models** by itself. + +This phrase applies when specifically referring to the feature name only. +If you're writing about [self-hosted models](#self-hosted-model), no need to use title case. + ## self-managed Use **self-managed** to refer to a customer's installation of GitLab. Do not use **self-hosted**. diff --git a/doc/user/gitlab_duo/index.md b/doc/user/gitlab_duo/index.md index 04827392a2e1e..8580671c4aaa5 100644 --- a/doc/user/gitlab_duo/index.md +++ b/doc/user/gitlab_duo/index.md @@ -148,6 +148,16 @@ DETAILS: ## Beta features +### Self-Hosted Models + +DETAILS: +**Tier:** For a limited time, Premium and Ultimate. In the future, [GitLab Duo Enterprise](../../subscriptions/subscription-add-ons.md). +**Offering:** Self-managed +**Status:** Beta + +- Host a GitLab-approved model that's different from the default. +- [View documentation](../../administration/self_hosted_models/index.md). + ### Merge Request Summary DETAILS: -- GitLab