> For the complete documentation index, see [llms.txt](https://docs.acecloud.ai/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.acecloud.ai/knowledge-base/ai-hub/getting-started-with-ace-inference-endpoints.md).

# Getting Started with Ace Inference Endpoints

## a. How to Create an Inference Endpoint?

**Step 1:** [Log in](https://customer.acecloudhosting.com/app/login) to AceCloud portal.

**Step 2:** From the left-hand menu, select **AI HUB** and then choose **Endpoints**.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2Fo4AEfi8JEkfM2fnkn8co%2Fimage.png?alt=media&amp;token=85ba8d3e-8ae0-488f-91f5-0fd3237e08ee" alt=""><figcaption></figcaption></figure>

**Step 3:** Click on **Create Endpoint**.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2Fn5BNn5Bz803JieVgOaaD%2Fimage.png?alt=media&amp;token=6575b0a4-0a64-4e52-a299-b9a6bc47c25e" alt=""><figcaption></figcaption></figure>

**Step 4:** Enter the endpoint name, paste the HuggingFace model ID or URL, or choose from the available models for quick deployment.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FNBoQCrlXwRcvOvOKMOpx%2Fimage.png?alt=media&amp;token=a7a759fe-b180-4327-bb42-8fa97f490e0c" alt=""><figcaption></figcaption></figure>

For private and gated models, please configure a HuggingFace token in the secrets (add a link to the secret page).

Additionally, you can disable authentication for endpoint requests.

***Note:*** *The user would receive the public URL of the model hosted.*

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FYPlxhpXPU721H3b4G3No%2Fimage.png?alt=media&amp;token=ca3d1284-f47c-4a7b-8866-ea5aa4407d98" alt=""><figcaption></figcaption></figure>

**Step 5:** Configure compute resources and scaling.

Choose from the available flavors.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FMns8PhnxmpMIpzU7yWLg%2Fimage.png?alt=media&amp;token=d68ceac5-c6b1-41f2-87fd-b2254ee52170" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FGv2K22QCdRgZrFYhDzhG%2Fimage.png?alt=media&amp;token=2b43ab95-af53-4e1f-884c-5e4aff829492" alt=""><figcaption></figcaption></figure>

| **Field**              | **Description**                                                                                   |
| ---------------------- | ------------------------------------------------------------------------------------------------- |
| Shared                 | Shared GPU resource, meaning a single GPU is sliced and shared among many users.                  |
| Dedicated              | Dedicated GPU resource meaning GPU(s) belongs to a single user.                                   |
| Replicas               | Number of instances for your endpoint.                                                            |
| Model Volume Size (GB) | Storage space allocated for the model.                                                            |
| Billing Cycle          | Applies to the compute and model storage for this endpoint. (Add link to the pricing policy page) |
| Max Ongoing Requests   | The maximum number of concurrent requests allowed to be called on this endpoint.                  |

**Step 6:** Configure the vLLM inference engine parameters.

***Note:** These are advanced settings. Default values work for most use cases.*

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FEfzGzmF9BOgetNOTqvwN%2Fimage.png?alt=media&amp;token=b87fecb1-d10b-4c93-834b-58ac8646dae6" alt=""><figcaption></figcaption></figure>

| **Field**                | **Description**                                                                                                                                                                                                                                                  |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| gpu\_memory\_utilization | The fraction of GPU VRAM to reserve for the model and KV cache. A value of 1 means 100% of VRAM is used. Lowering it (e.g., to 0.9) leaves headroom to avoid out-of-memory errors, but reduces throughput.**Required for dedicated and MIG shared deployments.** |
| tensor\_parallel\_size   | The number of GPUs to split the model across. This shards model layers across GPUs, enabling larger models to fit in memory.                                                                                                                                     |
| dtype                    | Precision format for model weights and computations. Auto lets vLLM pick the optimal type based on the model configuration and hardware.                                                                                                                         |
| max\_model\_len          | Maximum sequence length (in tokens) the model can handle per request.                                                                                                                                                                                            |
| cpu\_offload\_gb         | Amount of model weight (in GB) to offload to CPU RAM when VRAM is insufficient. Increasing this helps fit larger models at the cost of slower inference.                                                                                                         |

You can also add custom keyword arguments for additional configuration.

For more information, refer to [Engine Arguments - vLLM](https://docs.vllm.ai/en/latest/configuration/engine_args/)

**Step 7:** Review your configuration and click **Create Endpoint** to deploy.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2Fgk3Kax9BlOcdbrTHFkbL%2Fimage.png?alt=media&amp;token=8bff08f6-3bbc-45ff-800d-cc3f251db6ed" alt=""><figcaption></figcaption></figure>

***Note:** This endpoint is OpenAI API compatible, meaning you can interact with it using any OpenAI-compatible client or SDK without changing your existing code. For details on the supported request and response format, refer to the* [*OpenAI Chat API Reference*](https://developers.openai.com/api/reference/resources/chat)*.*

## b. How to Edit an Inference Endpoint?

**Step 1:** Select the endpoint you want to edit, click the **Actions** menu, and choose **Edit Endpoint**.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FzEek2oyFYs5o37fcQALA%2Fimage.png?alt=media&amp;token=04a8ce97-526e-43ff-923b-b30959c0c180" alt=""><figcaption></figcaption></figure>

***Note:** All updates are rolling updates, meaning your endpoint will remain active during the update process.*

**Step 2:** Update the endpoint details under **Basic Details**.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FKC88UOmXtifp6DWiRyyX%2Fimage.png?alt=media&amp;token=cab212ea-12d4-4bd0-a2d7-9b6094a44681" alt=""><figcaption></figcaption></figure>

| **Field**             | **Description**                                                                                                  |
| --------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Model Selection       | HuggingFace model ID or URL. You can also browse and select from trending models using the Quick Deploy section. |
| HuggingFace Token     | Required for private and gated models. Select an existing token or create a new secret.                          |
| Enable Authentication | Toggle to require authentication for all endpoint requests.                                                      |

**Step 3:** Configure compute resources under **Resource Configuration**.

***Note:** Only upscaling is allowed as per our internal policies.*

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FJvg28fFN5rJ9bxVKLOCH%2Fimage.png?alt=media&amp;token=1c5dc103-eb0a-424e-87de-8fc1dfd312ae" alt=""><figcaption></figcaption></figure>

| **Field**              | **Description**                                                                  |
| ---------------------- | -------------------------------------------------------------------------------- |
| Shared                 | Shared GPU resource, meaning a single GPU is sliced and shared among many users. |
| Dedicated              | Dedicated GPU resource meaning GPU(s) belongs to a single user.                  |
| Replicas               | Number of instances for your endpoint.                                           |
| Model Volume Size (GB) | Storage space allocated for the model.                                           |
| Billing Cycle          | Applies to the compute and model storage for this endpoint.                      |
| Max Ongoing Requests   | The maximum number of concurrent requests allowed to be called on this endpoint. |

**Step 4:** Adjust the vLLM inference engine parameters under **Engine Configuration**.

***Note:** These are advanced settings. Default values work for most use cases.*

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FrHT36Tq1TOaTHZCjOvMs%2Fimage.png?alt=media&amp;token=bdc2a4d5-4eda-4a67-874c-0e059ec927c2" alt=""><figcaption></figcaption></figure>

| **Field**                | **Description**                                                                                                                                                                                                                                               |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| gpu\_memory\_utilization | The fraction of GPU VRAM to reserve for the model and KV cache. A value of 1 means 100% of VRAM is used. Lowering it (e.g., to 0.9) leaves headroom to avoid out-of-memory errors, but reduces throughput. Required for dedicated and MIG shared deployments. |
| tensor\_parallel\_size   | The number of GPUs to split the model across. This shards model layers across both GPUs, enabling larger models to fit in memory.                                                                                                                             |
| dtype                    | Precision format for model weights and computations. Auto lets vLLM pick the optimal type based on the model configuration and hardware.                                                                                                                      |
| max\_model\_len          | Maximum sequence length (in tokens) the model can handle per request.                                                                                                                                                                                         |
| cpu\_offload\_gb         | Amount of model weight (in GB) to offload to CPU RAM when VRAM is insufficient. Increasing this helps fit larger models at the cost of slower inference.                                                                                                      |

*You can also add custom keyword arguments for additional configuration.*

**Step 5:** Click **Update Endpoint** to apply your changes.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FhciBKlsONrlsfKpoi4i5%2Fimage.png?alt=media&amp;token=cf3a2abd-7acc-4728-abf5-59e0b5c852bb" alt=""><figcaption></figcaption></figure>

## c. How to Delete an Inference Endpoint?

**Step 1:** Click the **Actions** menu next to the endpoint you want to delete and select **Delete Endpoint**.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FQR4YLB6QgvI844urPZly%2Fimage.png?alt=media&amp;token=e2cf195a-a5a7-4be5-b52a-6669b1fc9075" alt=""><figcaption></figcaption></figure>

**Step 2:** A confirmation dialog will appear. Click **Delete Endpoint** to confirm.

<figure><img src="https://3583118809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx7qtmvknXddwSLcCYKFC%2Fuploads%2FrXtmmGbAYAmGf8E2I2Uw%2Fimage.png?alt=media&amp;token=bff9ae73-0094-4b44-b075-64d536eb5a2f" alt=""><figcaption></figcaption></figure>

***Note:** Endpoint deletion may take 30-60 seconds to complete*.
