diff --git a/docs/cli/commands/index.md b/docs/cli/commands/index.md index 1cc979a9..440abf6c 100644 --- a/docs/cli/commands/index.md +++ b/docs/cli/commands/index.md @@ -69,4 +69,4 @@ So, the final format of this option must be one of the following: - `--solution ,`. For example, `--solution 13,15`. - `--solution `. 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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/colab/cli.md b/docs/colab/cli.md index 37802cff..011d69c4 100644 --- a/docs/colab/cli.md +++ b/docs/colab/cli.md @@ -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). @@ -26,7 +28,7 @@ import TabItem from '@theme/TabItem';

-### Set up SPCTL—the Super Protocol CLI tool. +### Set up SPCTL 1. Save your web3 account private key. diff --git a/docs/colab/gui.md b/docs/colab/gui.md index 210acbd2..2a4352cd 100644 --- a/docs/colab/gui.md +++ b/docs/colab/gui.md @@ -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). diff --git a/docs/fundamentals/images/fundamentals_offers_1.png b/docs/fundamentals/images/fundamentals_offers_1.png deleted file mode 100644 index e1a91d82..00000000 Binary files a/docs/fundamentals/images/fundamentals_offers_1.png and /dev/null differ diff --git a/docs/fundamentals/offers.md b/docs/fundamentals/offers.md index 17293048..463eb4e0 100644 --- a/docs/fundamentals/offers.md +++ b/docs/fundamentals/offers.md @@ -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. - -
-
- 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. diff --git a/docs/guides/deploy-model.md b/docs/guides/deploy-model.md index 0426cb13..6fd8e6cf 100644 --- a/docs/guides/deploy-model.md +++ b/docs/guides/deploy-model.md @@ -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 offers 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 @@ -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 offer 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**.

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

-- **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 engines; it is recommended to select both variants: - - **GPU-only** engines require CPU+GPU compute 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. - + +
+
+ +2.4. Open the **Content** tab and click **Upload Content**. + + +

+2.5. Select the model files or folder and click **Upload**. + + +
+
+ +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 order for a quick deployment. +3.1. In the Offer Builder, click **Deploy**. You will be redirected to the Order Builder with a preconfigured order for a quick deployment. + + +
+
-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.

-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.
@@ -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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/guides/log-in.md b/docs/guides/log-in.md index 944c3382..5a31c671 100644 --- a/docs/guides/log-in.md +++ b/docs/guides/log-in.md @@ -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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/guides/prepare-comfyui.md b/docs/guides/prepare-comfyui.md index 4c568e3a..22430ba2 100644 --- a/docs/guides/prepare-comfyui.md +++ b/docs/guides/prepare-comfyui.md @@ -93,7 +93,7 @@ You can prepare your model, workflow, and custom node files manually or using Do - Replace `` 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. @@ -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. ## 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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/guides/publish-offer.md b/docs/guides/publish-offer.md index 407f8477..b47ec0c2 100644 --- a/docs/guides/publish-offer.md +++ b/docs/guides/publish-offer.md @@ -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 offers 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 @@ -24,86 +18,38 @@ Uploading models and creating o

-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**.
-## 2. Create an offer - -2.1. In the **My Offers** screen, click the **New Offer** button. - - -
-
- -2.2. Complete all the fields in the appearing window. +## 2. Deploy your model - -
-
- -- **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 engines; it is recommended to select both variants: - - **GPU-only** engines require CPU+GPU compute 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. - - -
-
- -Alternatively, click the **Edit** button next to the offer in the **My Offers** screen. - - -
- -## 4. Check the model files - -In the **Files** tab, ensure the model formats are recognized correctly. - - -
-
- -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.

-- **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 requirement slot. @@ -111,24 +57,22 @@ In the **Pricing** tab, click the **Add Slot** button to open an editable templa

-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. - - Complete the following fieds: + + 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 order, 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**. - - Complete the following fieds: + + 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 order, regardless of the lease duration. @@ -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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/guides/storage.md b/docs/guides/storage.md index 9ace7380..ee5ed3ea 100644 --- a/docs/guides/storage.md +++ b/docs/guides/storage.md @@ -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). diff --git a/docs/guides/troubleshooting.md b/docs/guides/troubleshooting.md index 43adbabc..79b8c682 100644 --- a/docs/guides/troubleshooting.md +++ b/docs/guides/troubleshooting.md @@ -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. \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/marketplace/account/index.md b/docs/marketplace/account/index.md index dc2a1563..9f4566b0 100644 --- a/docs/marketplace/account/index.md +++ b/docs/marketplace/account/index.md @@ -12,15 +12,16 @@ There are two types of accounts in Super Protocol:
+
## Web3 User account -_Web3 User account_ is the recommended account type in Super Protocol. It provides access to all Marketplace capabilities, including: +_Web3 User account_ provides access to all Marketplace capabilities, including: - Full decentralization and sole control of user's funds, models, and datasets. - Ability to upload models and datasets to the Super Protocol cloud or a personal Storj account. - Placement of orders using Marketplace offers or the user's own uploaded content. -- Registration of individual providers and full control of earned funds and rewards. +- Registration of individual providers. - Creation and monetization of model and dataset offers on the Marketplace. - Ability to request additional SPPI tokens. @@ -30,11 +31,6 @@ Read [How to Log In as a Web3 User](/guides/log-in) for step-by-step instruction _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. -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 Web2 user, you need an account on one of the supported platforms: - Google diff --git a/docs/marketplace/images/new-offer.png b/docs/marketplace/images/new-offer.png index 52d03512..3b55ec14 100644 Binary files a/docs/marketplace/images/new-offer.png and b/docs/marketplace/images/new-offer.png differ diff --git a/docs/marketplace/images/offer-builder-category-engine.png b/docs/marketplace/images/offer-builder-category-engine.png new file mode 100644 index 00000000..4886f76a Binary files /dev/null and b/docs/marketplace/images/offer-builder-category-engine.png differ diff --git a/docs/marketplace/images/offer-builder-deploy.png b/docs/marketplace/images/offer-builder-deploy.png new file mode 100644 index 00000000..de43d5da Binary files /dev/null and b/docs/marketplace/images/offer-builder-deploy.png differ diff --git a/docs/marketplace/images/offer-builder-description.png b/docs/marketplace/images/offer-builder-description.png index a7768a57..e4790515 100644 Binary files a/docs/marketplace/images/offer-builder-description.png and b/docs/marketplace/images/offer-builder-description.png differ diff --git a/docs/marketplace/images/offer-builder-format.png b/docs/marketplace/images/offer-builder-format.png deleted file mode 100644 index 53935551..00000000 Binary files a/docs/marketplace/images/offer-builder-format.png and /dev/null differ diff --git a/docs/marketplace/images/offer-builder-upload-content.png b/docs/marketplace/images/offer-builder-upload-content.png new file mode 100644 index 00000000..100e751b Binary files /dev/null and b/docs/marketplace/images/offer-builder-upload-content.png differ diff --git a/docs/marketplace/images/upload-content.png b/docs/marketplace/images/upload-content.png new file mode 100644 index 00000000..ad90cca7 Binary files /dev/null and b/docs/marketplace/images/upload-content.png differ diff --git a/docs/marketplace/order-builder/checkout.md b/docs/marketplace/order-builder/checkout.md index df1ff922..40b52f00 100644 --- a/docs/marketplace/order-builder/checkout.md +++ b/docs/marketplace/order-builder/checkout.md @@ -30,4 +30,4 @@ If an error occurs during transaction confirmation, you will see the error messa

-To retry, click the **Try again** button. If the error persists, 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. \ No newline at end of file +To retry, click the **Try again** button. If the error persists, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new). \ No newline at end of file diff --git a/src/theme/Layout/index.js b/src/theme/Layout/index.js index ee2f8142..30762d64 100644 --- a/src/theme/Layout/index.js +++ b/src/theme/Layout/index.js @@ -20,7 +20,7 @@ export default function Layout(props) { Offers are divided into four categories:
ᐧ Compute offers: Confidential computing resources required to execute solutions and data inside a Trusted Execution Environment.
ᐧ Solution offers: Engines, applications, scripts, base images, or other software.
- ᐧ Data offers: AI models, webpages, configs, datasets, databases, or any other data that solutions may require.
+ ᐧ Data offers: AI models, webpages, configs, datasets, databases, or any other data.
ᐧ Storage offers: Decentralized storage that keeps order results after execution. @@ -46,7 +46,7 @@ export default function Layout(props) { - Requirements specify how much computing resources a value offer needs to run.
+ Requirements specify how much computing resources an offer needs to run.
A requirement slot is a particular set of requirements that may include CPU, RAM, disk space, bandwidth, traffic, etc.