Skip to content
Merged
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
2 changes: 1 addition & 1 deletion docs/cli/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ So, the final format of this option must be one of the following:
- `--solution <offerId>,<slotId>`. For example, `--solution 13,15`.
- `--solution <path>`. For example, `--solution ./python-solution.json`.

Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
4 changes: 3 additions & 1 deletion docs/colab/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import TabItem from '@theme/TabItem';

## Before you begin

Register accounts and set up SPCTL—the Super Protocol CLI tool.

### Create an account and get tokens

1. Complete the first two steps of the guide [Log In as a Web3 User](https://docs.superprotocol.com/guides/log-in) (MetaMask is recommended).
Expand All @@ -26,7 +28,7 @@ import TabItem from '@theme/TabItem';
<br/>
<br/>

### Set up SPCTL—the Super Protocol CLI tool.
### Set up SPCTL

1. Save your web3 account private key.

Expand Down
4 changes: 3 additions & 1 deletion docs/colab/gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ slug: "/gui"
sidebar_position: 1
---

## Before you begin: Log in and get tokens
## Before you begin

Log in and get tokens.

1. Open the [Marketplace](https://marketplace.superprotocol.com).

Expand Down
Binary file removed docs/fundamentals/images/fundamentals_offers_1.png
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/fundamentals/offers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ Offers are the basic building blocks of the Marketplace. Four types of offers ex

_Value offer_ is a collective term for solution, data, and storage offers.

<img src={require('./images/fundamentals_offers_1.png').default} width="auto" height="auto"/>
<br/>
<br/>

Usually, placing an order involves adding all four types of offers. However, customers can also upload their solutions and data instead of using an existing offer.

Every offer has an identification number—_offer ID_. It is incremental and unique for all offers regardless of their type.
Expand Down
57 changes: 34 additions & 23 deletions docs/guides/deploy-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,7 @@ slug: "/deploy-model"
sidebar_position: 3
---

This guide provides step-by-step instructions for uploading and deploying an AI model.

:::note

Uploading models and creating <a id="offer"><span className="dashed-underline">offers</span></a> are currently available to Web2 users only.

:::
This guide provides step-by-step instructions for uploading and deploying an AI model on Super Protocol.

## 1. Prepare

Expand Down Expand Up @@ -43,45 +37,62 @@ If you plan to deploy a ComfyUI workflow with custom nodes, [prepare the files](

1.2. Due to [testnet limitations](/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future.

## 2. Upload
## 2. Create an offer

2.1. Open **My Offers** and click the **New Offer** button.
To deploy your model, you need to create a new <a id="offer"><span className="dashed-underline">offer</span></a> and upload model files. The offer will remain private and unavailable to other users until you [publish it](/guides/publish-offer).

2.1. Open [Super Protocol AI Marketplace](https://marketplace.superprotocol.com/marketplace), go to **My Offers**, and click **New Offer**.

<img src={require('../marketplace/images/my-offers-new-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.2. Complete all fields in the appearing window.
2.2. Enter the model name and click **Create Offer**.

<img src={require('../marketplace/images/new-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

- **Name**: Type in the model name. Providing a meaningful name makes it easier to find the model later.
- **Category**: Select the type of task that the model is designed to perform.
- **Engine**: Select compatible <a id="engine"><span className="dashed-underline">engines</span></a>; it is recommended to select both variants:
- **GPU-only** engines require CPU+GPU <a id="compute"><span className="dashed-underline">compute</span></a> offers.
- **CPU-only** engines can run on both CPU-only and CPU+GPU compute offers. However, models work much slower in this mode.
- **Upload**: Click to upload files or a directory. The selected directory will become the root after upload.
2.3. In the Offer Builder, select the model's **Category** and **Engine**.

2.3. Click **Create Offer**. Do not close the window until the upload is complete. This may take a few minutes.
Engines exist in two variants; select both if you are not sure:

2.4. When the upload is complete, close the window or click **Go to Offer** to open the offer in the [Offer Builder](/marketplace/my-offers/offer-builder).
- **GPU-only** to run models with GPU support; it requires CPU+GPU compute offers.
- **CPU-only** to run models without GPU support. Note that models work significantly slower in this mode.

<img src={require('../marketplace/images/new-offer-go-to-offer.png').default} width="auto" height="auto" border="1"/>
<img src={require('../marketplace/images/offer-builder-category-engine.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.4. Open the **Content** tab and click **Upload Content**.

<img src={require('../marketplace/images/offer-builder-upload-content.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.5. Select the model files or folder and click **Upload**.

<img src={require('../marketplace/images/upload-content.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.6. Wait until the upload is complete and close the **Upload Content** window.

## 3. Deploy

3.1. Click the **Deploy** button next to your offer in the My Offers screen or the bottom-right corner of the Offer Builder. You will be redirected to the [Order Builder](/marketplace/order-builder) with a preconfigured <a id="order"><span className="dashed-underline">order</span></a> for a quick deployment.
3.1. In the Offer Builder, click **Deploy**. You will be redirected to the Order Builder with a preconfigured <a id="order"><span className="dashed-underline">order</span></a> for a quick deployment.

<img src={require('../marketplace/images/offer-builder-deploy.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

3.2. In the Order Builder, review and modify the order if necessary. Click **Pay Now** to place the order.
3.2. In the Order Builder, review and modify the order if necessary. Click **Pay Now** to place your order.

<img src={require('../marketplace/images/order-builder-pay-now.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

3.3. When the order is created, you will be redirected to the [Order](/marketplace/all-orders/order) screen. Wait until the deployment is ready. It may take 15-45 minutes, depending on the model size and other factors.
3.3. When the order is created, you will be redirected to the Order screen. Wait until the deployment is ready. It may take 15-45 minutes, depending on the model size and other factors.

<img src={require('../marketplace/images/order-processing.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand All @@ -93,4 +104,4 @@ If you plan to deploy a ComfyUI workflow with custom nodes, [prepare the files](

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
2 changes: 1 addition & 1 deletion docs/guides/log-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,4 +244,4 @@ Super Protocol is not affiliated with MetaMask or Trust Wallet.

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
6 changes: 3 additions & 3 deletions docs/guides/prepare-comfyui.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ You can prepare your model, workflow, and custom node files manually or using Do

- Replace `<MODEL_DIRECTORY>` with the name of the output directory.

The output directory is ready for [upload](/guides/deploy-model#2-upload) to Super Protocol.
The output directory is ready for [upload](/guides/deploy-model#2-create-an-offer) to Super Protocol.

</TabItem>
<TabItem value="manually" label="Manually">
Expand Down Expand Up @@ -154,11 +154,11 @@ You can prepare your model, workflow, and custom node files manually or using Do
└── my-openjourney-workflow.json
```

The model directory is ready for [upload](/guides/deploy-model#2-upload) to Super Protocol.
The model directory is ready for [upload](/guides/deploy-model#2-create-an-offer) to Super Protocol.

</TabItem>
</Tabs>

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
102 changes: 23 additions & 79 deletions docs/guides/publish-offer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ sidebar_position: 4
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide provides step-by-step instructions on how to register a provider and publish an AI model on the Marketplace.

:::note

Uploading models and creating <a id="offer"><span className="dashed-underline">offers</span></a> are currently available to Web2 users only.

:::
This guide provides step-by-step instructions on how to create a provider and publish an AI model on the Marketplace.

## 1. Create a provider

Expand All @@ -24,111 +18,61 @@ Uploading models and creating <a id="offer"><span className="dashed-underline">o
<br/>
<br/>

1.2. Scroll down, type in the desired **Provider Name**, and click **Create Provider**.
1.2. Scroll down, enter the desired **Provider Name**, and click **Create Provider**.

<img src={require('../marketplace/images/account-create-provider.png').default} width="auto" height="auto" border="1"/>
<br/>

## 2. Create an offer

2.1. In the **My Offers** screen, click the **New Offer** button.

<img src={require('../marketplace/images/my-offers-new-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.2. Complete all the fields in the appearing window.
## 2. Deploy your model

<img src={require('../marketplace/images/new-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

- **Name**: Type in the model name. Providing a meaningful name makes it easier to find the offer on the Marketplace.
- **Category**: Select the type of task that the model is designed to perform.
- **Engine**: Select compatible <a id="engine"><span className="dashed-underline">engines</span></a>; it is recommended to select both variants:
- **GPU-only** engines require CPU+GPU <a id="compute"><span className="dashed-underline">compute</span></a> offers.
- **CPU-only** engines can run on both CPU-only and CPU+GPU compute offers. However, models work much slower in this mode.
- **Upload**: Click to upload files or a directory. The selected directory will become the root after upload.

:::note
Follow the [Deploy Your Model](/guides/deploy-model) guide and verify that your model runs successfully.

Due to [Testnet limitations](/marketplace/limitations), the total size of the model files should not exceed 13 GB. Support for bigger models will be available in the future.
## 3. Configure the offer

:::
The offer you created to deploy your model is unpublished. You need to configure it in the Offer Builder before publishing on the Marketplace.

1.3. Click the **Create Offer** button. Do not close the window until the upload is complete. This may take a few minutes.

## 3. Open the Offer Builder

The created offer is unpublished. You need to configure it in the Offer Builder before publishing to the Marketplace.

To open the offer in the Offer Builder, click **Go to Offer** in the **New Offer** window.

<img src={require('../marketplace/images/new-offer-go-to-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Alternatively, click the **Edit** button next to the offer in the **My Offers** screen.

<img src={require('../marketplace/images/my-offers-edit.png').default} width="auto" height="auto" border="1"/>
<br/>

## 4. Check the model files

In the **Files** tab, ensure the model formats are recognized correctly.

<img src={require('../marketplace/images/offer-builder-format.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

If you need to upload more files related to this model, click the **Add Files** button.

## 5. Provide the offer description

In the **Description** tab, provide information about the offer. It is recommended that you complete all the fields.
Go to **My Offers** and select the offer you want to publish. In the **Description** tab, provide additional information about the model. Complete all fields to improve discoverability.

<img src={require('../marketplace/images/offer-builder-description.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

- **About\***: Write a general model description. This field supports Markdown. If the model files contain a `README.md` file, the description will be taken from it.
- **Name\***: Change the offer name if you like or leave the name you gave during the offer creation.
- **Category\***: Change the model category if you like or leave the one you selected during the offer creation.
- **Engine\***: Change the engine selection if you like or leave those you selected during the offer creation.
- **About\***: Write a general model description; you can use Markdown. If the model files contain a `README.md` file, the description will be taken from it.
- **Name\***: Change the offer name or leave as is.
- **Category\***: Change the model category or leave the one you already selected.
- **Engine\***: Change the engine selection or leave those you already selected.
- **Parameters**: Specify the number of model parameters in millions or billions.
- **License\***: State the license under which the model is distributed.
- **Source URL**: Provide a link to the resource with the model files.
- **Languages**: Select supported languages.
- **Libraries**: Select the libraries that the model requires.
- **Libraries**: Select required libraries.

Fields required to publish the offer are marked with \*.

## 6. Create requirement slots
## 4. Create requirement slots

In the **Pricing** tab, click the **Add Slot** button to open an editable template for a <a id="requirements"><span className="dashed-underline">requirement slot</span></a>.

<img src={require('../marketplace/images/offer-builder-pricing.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

You can create and configure multiple slots for each offer.

If the offer supports both GPU-only and CPU-only engines, create at least one slot for each type to enable deployment on both.
Each offer can include multiple requirement slots. If the model supports both GPU and CPU execution, define at least one slot for each mode.

<Tabs>
<TabItem value="gpu" label="To deploy the model on GPU" default>
Complete the following fieds:
<TabItem value="gpu" label="To deploy the model on a GPU" default>
Complete the following fields:

- **Price**: Set the price in SPPI tokens for leasing the model and select the pricing type:
- **Fixed**: A one-time payment for each <a id="order"><span className="dashed-underline">order</span></a>, regardless of the lease duration.
- **Per Hour**: Payment is based on the number of hours the offer is leased.
- **Disk**: Set the required disk space in gigabytes (GB). It should not be less than the sum of all model files.
- **Disk**: Set the required disk space in gigabytes (GB). It must not be less than the sum of all model files.
- **GPU RAM**: Set the required video RAM in gigabytes (GB).
- **Min Time** and **Max Time**: Set the minimum and maximum lease duration limits, as defined by the provider. `0` means no limit.
- Set all other fields to `0`, including **CPU RAM**.
</TabItem>
<TabItem value="cpu" label="To deploy the model on CPU">
Complete the following fieds:
<TabItem value="cpu" label="To deploy the model on a CPU">
Complete the following fields:

- **Price**: Set the price in SPPI tokens for leasing the model and select the pricing type:
- **Fixed**: A one-time payment for each <a id="order"><span className="dashed-underline">order</span></a>, regardless of the lease duration.
Expand All @@ -144,12 +88,12 @@ Click **Save** to create a slot.

If the uploaded model exists in several formats, create requirement slots for each of them.

## 7. Publish the offer
## 5. Publish the offer

Click **Publish Offer** in the bottom-right corner to validate and publish the offer on the Marketplace. If validation is unsuccessful, you will see yellow indicators marking the fields that need to be configured before the offer can be published.
Click **Publish Offer** in the bottom-right corner to validate and publish the offer on the Marketplace. If validation is unsuccessful, you will see yellow indicators marking the fields that need to be configured before you can publish the offer.

If you want to unpublish the offer, click the **[ ⋮ ]** button in the top-right corner of the screen. Note that offers cannot be completely deleted due to the blockchain immutability. However, unpublished offers do not appear on the Marketplace and cannot be used in orders.
If you want to unpublish the offer, click the **[ ⋮ ]** button in the top-right corner of the screen. Unpublished offers do not appear on the Marketplace and can be used only by you. Note that offers cannot be completely deleted due to blockchain immutability.

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
2 changes: 1 addition & 1 deletion docs/guides/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Select the **Your Storj account** radio button, fill in the fields, and click **

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
2 changes: 1 addition & 1 deletion docs/guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ Possible reasons:

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance.
If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
Loading
Loading