-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
36 changed files
with
269 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: Deploying Refact.ai on AWS - Launch Through EC2 | ||
description: A page with instructions on how to deploy Refact on AWS. | ||
--- | ||
|
||
When deploying Refact.ai through the Amazon EC2 Console, you will see the form with pre-filled values. Only two of these values need to be manually changed. | ||
|
||
## Instance Name | ||
|
||
The instance name is the name that will be used to identify the instance in the AWS console. This value needs to be entered manually. | ||
|
||
![Instance Name](../../../../../assets/instance_name.png) | ||
|
||
## Application and OS Images (Amazon Machine Image) | ||
|
||
AMI (Amazon Machine Image) is the template that is responsible for containing the Refact.ai configurations. The AMI is pre-selected and does not need to be changed. | ||
|
||
![AMI](../../../../../assets/ami.png) | ||
|
||
## Instance Type | ||
|
||
The instance type is pre-selected and does not need to be changed. | ||
|
||
:::note | ||
`g5` family instance types are recommended for production use. Contact Refact.ai team for recommendation on the amount of GPUs suitable for your use case. | ||
::: | ||
|
||
![Instance Type](../../../../../assets/instance_type.png) | ||
|
||
## Key Pair (Optional) | ||
|
||
The key pair is necessary for SSH connections to your EC2 instance. | ||
To create a key pair press the `Create Key Pair` button. | ||
|
||
![Key Pair](../../../../../assets/key_pair.png) | ||
|
||
## Network Settings | ||
|
||
The network settings are pre-selected and do not need to be changed. | ||
The values should match the onees on the screenshot below. | ||
|
||
![Network Settings](../../../../../assets/network_settings.png) | ||
|
||
After verifying the settings, click on the `Launch Instance` button. | ||
You will see the following screen, confirming that the instance is being created. | ||
|
||
![Launch Instance](../../../../../assets/launch_instance_success.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Deploying Refact.ai on AWS - Getting Started | ||
description: A page with instructions on how to deploy Refact on AWS. | ||
--- | ||
|
||
This guide provides step-by-step instructions for deploying Refact on AWS. | ||
|
||
Navigate to Refact.ai Marketplace Page to deploy Refact on AWS. | ||
|
||
1. On the Refact.ai Marketplace page, press **Continiue to Subscribe**. | ||
![Refact.ai Marketplace Page](../../../../../assets/refact_marketplace.png) | ||
2. Accept the terms and conditions. | ||
![Refact.ai Marketplace Page](../../../../../assets/refact_terms.png) | ||
3. Press the **Continue to Configuration** button. | ||
![Continue to Configuration button](../../../../../assets/refact_continue.png) | ||
4. Select the **Region** and **Software Version**. Sotware version reffers to the Refact version you want to deploy. By default, the latest version is selected. | ||
![Select Region and Software Version](../../../../../assets/refact_region.png) | ||
|
||
Press the **Continue to Launch** button. There are two options to proceed with in the drop-down menu. Follow one of the guides to launch Refact: | ||
- [Launch through EC2](https://docs.refact.ai/guides/deployment/aws/ec2/) - this option is recommended for advanced users. | ||
- [Launch from Website](https://docs.refact.ai/guides/deployment/aws/marketplace/) - this option is recommended for faster deployment. | ||
|
||
![Launch Instance](../../../../../assets/refact_launch.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Deploying Refact.ai on AWS - Through AWS Marketplace | ||
description: A page with instructions on how to deploy Refact on AWS. | ||
--- | ||
|
||
When selecting the option to deploy Refact.ai through the Marketplace page, you will be presented with a screen that will have everything pre-configured for you. | ||
|
||
![Markeplace Launch](../../../../../assets/launch_instance_marketplace.png) | ||
|
||
Once you click on the Launch button, you will be presented with a screen that will confirm that your instance is successfully deployed. | ||
|
||
![Launch Confirmation](../../../../../assets/launch_instance_marketplace_confirmation.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Deploying Refact.ai on AWS - Usage | ||
description: A page with instructions on how to deploy Refact on AWS. | ||
--- | ||
|
||
In order to use your Refact.ai instance on AWS, you need to navigate to the AWS Console and locate the newly created instance. | ||
|
||
![AWS Machine](../../../../../assets/aws_machine.png) | ||
|
||
In the instance summary, locate the `Public IPv4 DNS`. This is the value you will need to use to access your instance. | ||
|
||
After navigating to the instance, you will need to create an access token to use with Refact.ai. | ||
|
||
![Token Creation](../../../../../assets/token_creation.png) | ||
|
||
Once you have created the token, you need to activate your Refact.ai license. Navigate to the [License Activation Giude](https://docs.refact.ai/guides/version-specific/enterprise/license/) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
src/content/docs/guides/version-specific/enterprise/license.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Enterprise Refact Edition - Activating the License | ||
description: How to set up plugins for Enterprise Refact Edition | ||
--- | ||
|
||
## Enter your license key | ||
Navigate to the **License** page through the **Settings** drown menu in the top right corner and input your license key. | ||
|
||
![License Page](../../../../../assets/license-page.png) | ||
|
||
## Check Activation | ||
After activation, you will see the **number of users** and the **expiration date** for your license. | ||
|
||
![Active License](../../../../../assets/active-license.png) | ||
|
||
## Need an Enterprise License? | ||
If you don't have an enterprise license key, please [contact](https://refact.ai/contact/) the Refact team to get one. |
16 changes: 16 additions & 0 deletions
16
src/content/docs/guides/version-specific/enterprise/model-hosting.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Enterprise Refact Edition - Model Hosting | ||
description: What Enterprise Refact is and how it works. | ||
--- | ||
|
||
Refact Enterprise Refact is a version that is optimized for enterprise use cases. It allows you to use all of the models avaliable in Refact.ai Self-hosted and also supports vLLM models. | ||
|
||
### Enabling vLLM | ||
|
||
With the enterprise version of Refact, you can use an inference engine that uses `PagedAttention` from the vLLM library. It works faster and supports continuous batching, which means it can start work on new inference tasks, while continuing to serve other clients at the same time. | ||
|
||
To enable vLLM select one the available vLLM models in the **Model Hosting** page. The full list of available models can be found on the [Supported Models page](https://docs.refact.ai/supported-models/). | ||
|
||
:::note | ||
vLLM models are suitable for a fast inference. The limiatation with the vLLM models is that they **don't support sharding**. | ||
::: |
9 changes: 9 additions & 0 deletions
9
src/content/docs/guides/version-specific/enterprise/plugins.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Enterprise Refact Edition - Setting Up Plugins | ||
description: How to set up plugins for Enterprise Refact Edition | ||
--- | ||
|
||
- **VS Code**: go to **Settings** and specify the **server address** and **Refact API key** provided by your admin. | ||
- **JetBrains**: go to **Settings** and specify the **server address** and the **Refact API key** provided by your admin. | ||
|
||
Once you connect the API key, start writing code, and code suggestions from a selected model will appear automatically. |
Oops, something went wrong.