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 @@ -7,7 +7,7 @@ sidebar_position: 2

This section contains the list of commands for the Super Protocol CLI tool SPCTL.

[Configure SPCTL](/cli) before using these commands. Be mindful of the [testnet limitations](/marketplace/limitations) when using the Marketplace CLI and GUI.
[Configure SPCTL](/cli) before using these commands. Also keep in mind [testnet limitations](/marketplace/limitations).

## Command groups

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use the steps below as an outline of your learning curve with Super Protocol.
If you are just starting out, feel your way around Super Protocol using the Marketplace GUI.

1. [Set up MetaMask](/marketplace/guides/log-in) and connect to the Marketplace GUI.
2. Complete the Marketplace [Walkthrough](/developers/marketplace/walkthrough/) to create a sample tunnel order to get familiar with the Super Protocol logic.
2. Complete the [Marketplace Walkthrough](/developers/marketplace/walkthrough/) to create a sample tunnel order to get familiar with the Super Protocol logic.

## Deploy a solution with CLI

Expand All @@ -31,6 +31,6 @@ When you know the basics, try SPCTL—the Super Protocol CLI tool:
1. Follow the [Providers and Offers](/developers/cli_guides/providers_offers) guide to create your provider and a first offer.
2. Follow the [Moderation Guidelines](/developers/marketplace/moderation/) to approve your offer for Marketplace GUI.
3. [Update SPCTL configuration](/cli#for-offer-providers) as a provider to enable management of your provider and offers.
4. Use the [SPCTL commands](/developers/cli_guides/providers_offers#faq) to manage your provider and offers.
4. Use [SPCTL commands](/developers/cli_guides/providers_offers#faq) to manage your provider and offers.

Join us on [Discord](https://discord.gg/superprotocol). The Super Protocol team welcomes any feedback and questions!
4 changes: 2 additions & 2 deletions docs/marketplace/account/demo.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: "demo"
title: "Demo User Account"
title: "Web2 User Account"
slug: "/account/demo"
sidebar_position: 2
---

This window shows the settings of your [Demo User account](/marketplace/account#demo-user-account).
This window shows the settings of your [Web2 User account](/marketplace/account#demo-user-account).

<img src={require('../images/demo-account.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand Down
10 changes: 5 additions & 5 deletions docs/marketplace/account/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 3
There are two types of accounts in Super Protocol:

- Web3 User account
- Demo User account
- Web2 User account

<img src={require('../images/enter-marketplace.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand All @@ -26,16 +26,16 @@ _Web3 User account_ is the recommended account type in Super Protocol. It provid

Read [How to Log In as a Web3 User](/marketplace/guides/log-in) for step-by-step instructions.

## Demo User account
## Web2 User account

_Demo User account_ is a quick way to start with the Marketplace. It streamlines a few steps, but this comes at the expense of full decentralization, such as using OAuth2 authentication for login instead of the decentralized MetaMask.
_Web2 User account_ is a quick way to start with the Marketplace. It streamlines a few steps, but this comes at the expense of full decentralization, such as using OAuth2 authentication for login instead of the decentralized MetaMask.

Demo User accounts come with certain restrictions:
Web2 User accounts come with certain restrictions:

- Uploading files is only possible to the Super Protocol cloud, not personal Storj accounts.
- Offer creation is available only with the centralized Super Protocol provider.

To log in as a Demo user, you need an account on one of the supported platforms:
To log in as a Web2 user, you need an account on one of the supported platforms:

- Google
- Hugging Face
Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ sidebar_position: 2
| :- | :- |
| [How to Log In](/marketplace/guides/log-in) | Log in as a Web3 user and set up the account. |
| [How to Place an Order](/marketplace/guides/place-order) | Build and place an order using a model from **Marketplace** or **My Content**. |
| [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. |
| [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. |
| [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. |
| [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. |
| [How to Set Up Storage](/marketplace/guides/storage) | Set up your personal storage as a Web3 user. |
| [Troubleshooting](/marketplace/guides/troubleshooting) | Fix the most common issues. |
| How to Create an Offer | Register a provider and create an offer from an uploaded file. |
4 changes: 2 additions & 2 deletions docs/marketplace/guides/log-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide provides step-by-step instructions on how to log in to the [Super Protocol Marketplace](https://marketplace.superprotocol.com/) as a Web3 user. Learn more about [user account types](/marketplace/account).
This guide provides step-by-step instructions on how to log in to the [Super Protocol Marketplace](https://marketplace.superprotocol.com/) as a Web3 user. Read about [user account types](/marketplace/account).

:::note

Expand Down Expand Up @@ -128,7 +128,7 @@ Both types are necessary to place orders. During the testnet, you can request fr
<br/>
<br/>

There is a limit to the daily amount of tokens you can get. Refer to the [Testnet Limitations](/marketplace/limitations).
There is a limit to the daily amount of tokens you can get. Check the [Testnet Limitations](/marketplace/limitations).

## Contact Super Protocol

Expand Down
10 changes: 5 additions & 5 deletions docs/marketplace/guides/place-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Select a model you want to deploy. You can add either a model from the Marketpla
</TabItem>
<TabItem value="my-content" label="My Content">

To add your own model, you must prepare and upload it first. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.
To add your own model, you must prepare and upload it first. Read [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.

When your model is uploaded, open **My Files** and click the blue **[+]** button next to a model to add it to the order.

Expand All @@ -45,7 +45,7 @@ Once you add a model, open the **Order Builder** by clicking **Order** in the to
<br/>
<br/>

**Order Builder** is a tool to pick the order's components, configure them, calculate prices, and place orders. Refer to the [Order Builder](/marketplace/orders/order-builder) documentation to learn more.
**Order Builder** is a tool to pick the order's components, configure them, calculate prices, and place orders. Read about the [Order Builder](/marketplace/orders/order-builder).

## Step 2. Add an engine

Expand Down Expand Up @@ -90,7 +90,7 @@ The panel at the bottom of the screen displays the total prices:
- **Lease Time** is the duration for which you plan to run the order. Offers may have limits on the minimum and maximum allowed lease time.
- **Pay now** is the initial order deposit you must pay at checkout. It is calculated using the formula: **Fixed** + (**Per Hour** * **Lease Time**).

Set the desired **Lease Time**. During the testnet, it must be from two to four hours. Refer to the [Testnet Limitations](/marketplace/limitations).
Set the desired **Lease Time**. During the testnet, it must be from two to four hours. Check the [Testnet Limitations](/marketplace/limitations).

<img src={require('../images/order-builder-footer.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand All @@ -102,9 +102,9 @@ Click the **Checkout** button. The system will check for [compatibility issues](

This step is for Web3 users only.

Demo users do not need to confirm transactions; they do not pay using decentralized wallets. Instead, their payment relies on Super Protocol. The transactions are processed automatically.
Web2 users do not need to confirm transactions; they do not pay using decentralized wallets. Instead, their payment relies on Super Protocol. The transactions are processed automatically.

Web3 users, however, must confirm two transactions in MetaMask. The first transaction is for the main model's order; the second one is placed automatically to deploy a set of confidential tunnels to make the running model available from the internet. Learn more about [Tunnels](/fundamentals/tunnels).
Web3 users, however, must confirm two transactions in MetaMask. The first transaction is for the main model's order; the second one is placed automatically to deploy a set of confidential tunnels to make the running model available from the internet. Read about [Tunnels](/fundamentals/tunnels).

If you create an order for the first time, you need to confirm the spending cap. Click **Next** and then **Approve**.

Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/guides/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ sidebar_position: 6

This guide provides step-by-step instructions on how to set up your personal Storj account.

The guide is intended for advanced Web3 users; feel free to skip it and continue using the default recommended option—**Super Protocol cloud**. Learn more about [types of storage](/marketplace/account/web3#storage).
The guide is intended for advanced Web3 users; feel free to skip it and continue using the default recommended option—**Super Protocol cloud**. Read about [types of storage](/marketplace/account/web3#storage).

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

Demo users must first [log in as a Web3 user](/marketplace/guides/log-in) to be able to upload to a personal Storj account instead of the Super Protocol cloud.
Web2 users must first [log in as a Web3 user](/marketplace/guides/log-in) to be able to upload to a personal Storj account instead of the Super Protocol cloud.

## Step 1. Register a Storj account

Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/guides/upload-comfyui.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: "upload-comfyui"
title: "How to Upload Your Model (ComfyUI)"
title: "How to Upload a Model (ComfyUI)"
slug: "/guides/upload-comfyui"
sidebar_position: 5
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide provides step-by-step instructions for uploading a model supported by **ComfyUI** to Super Protocol. If your model is supported by Text Generation Web UI, refer to the [respective upload guide](/marketplace/guides/upload-tgwui).
This guide provides step-by-step instructions for uploading a model supported by **ComfyUI** to Super Protocol. If your model is supported by Text Generation Web UI, refer to the [respective guide](/marketplace/guides/upload-tgwui).

To deploy your model in Super Protocol, you need to complete the following steps:

Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/guides/upload-tgwui.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: "upload-tgwui"
title: "How to Upload Your Model (TGWUI)"
title: "How to Upload a Model (TGWUI)"
slug: "/guides/upload-tgwui"
sidebar_position: 4
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide provides step-by-step instructions for uploading a model supported by **Text Generation Web UI** to Super Protocol. If your model is supported by ComfyUI, refer to the [respective upload guide](/marketplace/guides/upload-comfyui).
This guide provides step-by-step instructions for uploading a model supported by **Text Generation Web UI** to Super Protocol. If your model is supported by ComfyUI, refer to the [respective guide](/marketplace/guides/upload-comfyui).

To deploy your model in Super Protocol, you need to complete the following steps:

Expand Down
17 changes: 9 additions & 8 deletions docs/marketplace/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,20 @@ Super Protocol constantly adds more TDX+H100 machines and will soon begin onboar
Pricing and restrictions:

- Order lease time: minimum 2 hours.
- Compute costs 2.126 TEE tokens in most cases.
- Models from the Marketplace cost 1 TEE per order.
- Engines cost 0.5 TEE per order.
- Tunnels Launcher fee for setting up a confidential tunnel is approximately 2 TEE per order.
- Compute costs 0.326 TEE tokens per hour in most cases.
- Models from the Marketplace cost 0 TEE per order.
- Engines cost 0 TEE per order.
- Setting up a confidential tunnel costs approximately 0.5 TEE per order.

For example, a two-hour GPU order will cost approximately:
For example, a two-hour GPU-order would cost:

2.126 * 2 + 1 + 0.5 + 2 = **~8** TEE tokens.
0.326 x 2 + ~0.5 = **1.1-1.2 TEE** tokens.

The total gas fee varies, but it is approximately **0.25-0.6 POL** per order.

## Token limits

- **Demo users** receive a one-time advance of 50 TEE tokens with no replenishment possibility. To continue testing, users must [log in with a Web3 account](/marketplace/guides/log-in).
- **Web3 users** can receive up to 35 TEE tokens tokens daily. At any given time, Web3 users can hold a maximum of 35 TEE tokens in their wallets.
All users can receive up to **5 TEE** tokens daily. Web3 users can also get up to **2 POL** tokens daily.

## Model limits

Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/marketplace/offer.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The **Pricing** tab contains the offer requirements, detailing how many confiden
- **Min Time** and **Max Time**: providers may set the minimum and maximum allowed lease time to limit the usage of the offer.
- **slotID**: a unique identification number of the requirement slot. It is incremental and continuous for model offers and dataset offers.

The offer provider can configure multiple requirement slots with varying prices based on expected usage. Higher requirements imply a higher expected workload, and the slot price may reflect that. Learn more about [requirement slots](/fundamentals/slots#requirements).
The offer provider can configure multiple requirement slots with varying prices based on expected usage. Higher requirements imply a higher expected workload, and the slot price may reflect that. Read about [requirement slots](/fundamentals/slots#requirements).

To add the offer to an order, click the blue **[+]** button next to a slot. **Offer added to Order** in the bottom-right corner of the window indicates that a requirement slot was added to the order:

Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/my-content/my-files/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Datasets are not yet available in the current version of the Marketplace.
<br/>
<br/>

The **Upload File** button opens the [**Upload Content**](/marketplace/my-content/my-files/upload-content) window. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.
The **Upload File** button opens the [**Upload Content**](/marketplace/my-content/my-files/upload-content) window. Read [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.

The table in the middle of the screen includes the following columns:

- **Type**: indicates whether the content is a **Model** or **Dataset**.
- **Name**: the name of the content. It may differ from the original file name.
- **Date Uploaded**: the date and time when the content was uploaded.
- **Size**: file size of the file in gigabytes. For the exact size in bytes, check the file's [**Info**](/marketplace/my-content/my-files/info).
- **Storage**: the storage to where you uploaded the content, either **Super Cloud** or **Storj**. Learn more about [types of storage](/marketplace/account/web3#storage).
- **Storage**: the storage to where you uploaded the content, either **Super Cloud** or **Storj**. Read about [types of storage](/marketplace/account/web3#storage).
- **Offer ID**: the identification number of the offer created from the uploaded file. No number means an offer has not yet been created.

To add a model or dataset to an order, click the blue **[+]** button next to it.
Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/my-content/my-files/upload-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ To upload a file, fill in all the fields:

You can change all this data later except for the uploaded file itself.

Note that before uploading a model or dataset, you must pack it into a TAR.GZ archive. The file will be uploaded to the storage specified in the Account settings. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.
Note that before uploading a model or dataset, you must pack it into a TAR.GZ archive. The file will be uploaded to the storage specified in the Account settings. Read [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.
2 changes: 1 addition & 1 deletion docs/marketplace/orders/all-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The table in the center of the screen provides essential information about your
- **Created Date**: the date and time when the customer placed the order.
- **Modified Date**: the date and time of the latest change in the order status.
- **Order ID**: a unique order identification number. It is incremental and continuous for all orders and suborders on Super Protocol.
- **Status**: current status of the order. Learn more about [statuses](/fundamentals/orders#order-status).
- **Status**: current status of the order. Read about [statuses](/fundamentals/orders#order-status).
- **Cost to Date**: the total amount of TEE tokens spent on the order so far.
- **Balance**: the remaining order balance. When it reaches zero, the order processing stops. To replenish the balance, open the **Order** screen and click the **Extend Lease** button.
- **Engine**: the AI engine that launches the model in the order.
Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/orders/order-builder/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Before your order can be processed, you must pay the initial order deposit. [**O
The confirmation process depends on the account type:

- **Web3 users** must confirm transactions in MetaMask. If the MetaMask browser extension do not open automatically, open it manually, select the transaction in the **Activity** tab, and confirm it.
- **Demo users** do not need to confirm transactions, as they do not pay using decentralized wallets. Instead, payment relies on Super Protocol. The transactions are processed automatically.
- **Web2 users** do not need to confirm transactions, as they do not pay using decentralized wallets. Instead, payment relies on Super Protocol. The transactions are processed automatically.

Besides the account type, the confirmation process also depends on the order type:

- **Deploy** orders require confirmation of two transactions—one to pay for the Deploy order and another for the Tunnels Launcher order. Tunnels Launcher creates a set of confidential tunnels necessary to access the running model from the internet. Learn more about [Tunnels](/fundamentals/tunnels).
- **Deploy** orders require confirmation of two transactions—one to pay for the Deploy order and another for the Tunnels Launcher order. Tunnels Launcher creates a set of confidential tunnels necessary to access the running model from the internet. Read about [Tunnels](/fundamentals/tunnels).
- **Fine-tune** orders only require confirmation of a single transaction. This type of orders is not availible yet in the current version of the Marketplace.

Once the order is placed successfully, you will be redirected to its [**Order**](/marketplace/orders/order) screen.
Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/orders/order-builder/compatibiity.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This message appears when the selected compute configuration does not meet the c
<br/>
<br/>

Ensure your order fits into the total maximum compute configuration allowed for the testnet. Refer to the [Testnet Limitations](/marketplace/limitations).
Ensure your order fits into the total maximum compute configuration allowed for the testnet. Check the [Testnet Limitations](/marketplace/limitations).

## Incorrect lease time

Expand Down
Loading
Loading