diff --git a/docs/fundamentals/certification.md b/docs/fundamentals/certification.md index 77944b65..441e6438 100644 --- a/docs/fundamentals/certification.md +++ b/docs/fundamentals/certification.md @@ -25,7 +25,7 @@ The SubRoot CAs, in turn, issue and sign certificates for [orders](/fundamentals ## Order certificates -The issuing of order certificates involves [Trusted Loader](/whitepaper/tee-provider/#trusted-loader-mechanism)—a mechanism developed to load and run applications within a TEE. Trusted Loader operates inside the Confidential VM that executes the order. This Confidential VM may be deployed within a CPU- or CPU/GPU-based TEE, such as Intel TDX, AMD SEV-SNP, NVIDIA GPU TEE, or other, making the whole system TEE-agnostic. +The issuing of order certificates involves [Trusted Loader](/whitepaper/tee-provider/#trusted-loader-mechanism)—a mechanism developed to load and run applications within a TEE. Trusted Loader operates inside the Confidential VM that executes the order. This Confidential VM may be deployed within a CPU-based or CPU/GPU-augmented TEE using technologies such as Intel TDX, AMD SEV-SNP, NVIDIA Confidential Computing, or others, making the system TEE-agnostic. To receive an order certificate, the Trusted Loader sends a request to a SubRoot CA providing the quote and a public key. The SubRoot CA verifies the quote, issues the order certificate, and signs it with the provided public key. diff --git a/docs/marketplace/account/web2.md b/docs/marketplace/account/web2.md index c726e32b..605e282b 100644 --- a/docs/marketplace/account/web2.md +++ b/docs/marketplace/account/web2.md @@ -7,7 +7,7 @@ sidebar_position: 2 This window shows the settings of your [Web2 User account](/marketplace/account#web2-user-account). - +

diff --git a/docs/marketplace/orders/all-orders.md b/docs/marketplace/all-orders/index.md similarity index 84% rename from docs/marketplace/orders/all-orders.md rename to docs/marketplace/all-orders/index.md index 40fe7f3b..c6806f5d 100644 --- a/docs/marketplace/orders/all-orders.md +++ b/docs/marketplace/all-orders/index.md @@ -1,11 +1,11 @@ --- id: "all-orders" title: "All Orders" -slug: "/orders/all-orders" -sidebar_position: 2 +slug: "/all-orders" +sidebar_position: 6 --- -This screens displays the full list of the orders you placed on Super Protocol. Read [How to Place an Order](/marketplace/guides/place-order) for step-by-step instructions. +This screens displays the full list of the orders you placed on Super Protocol.
@@ -23,6 +23,6 @@ The table in the center of the screen provides essential information about your - **Model**: the main model used in the order. - **Datasets**: the main dataset used in the order. Note that there may be several datasets in the order. -Clicking an order opens its [**Order**](/marketplace/orders/order) screen with detailed information. +Clicking an order opens its [**Order**](/marketplace/all-orders/order) screen with detailed information. The contents of all orders are encrypted and accessible only to the users who placed them. However, general information about orders is recorded on the blockchain and publicly visible due to the blockchain's transparent nature. \ No newline at end of file diff --git a/docs/marketplace/orders/order/index.md b/docs/marketplace/all-orders/order.md similarity index 89% rename from docs/marketplace/orders/order/index.md rename to docs/marketplace/all-orders/order.md index f4c839f8..b88de02f 100644 --- a/docs/marketplace/orders/order/index.md +++ b/docs/marketplace/all-orders/order.md @@ -1,13 +1,13 @@ --- id: "order" title: "Order" -slug: "/orders/order" -sidebar_position: 3 +slug: "/all-orders/order" +sidebar_position: 1 --- -This screen provides detailed information about an order. Read about [Orders](/fundamentals/orders). +This screen provides detailed information about a particular order. Read about [Orders](/fundamentals/orders). - +

@@ -27,11 +27,6 @@ Statuses specific for Deploy orders: - **Deployed**. The model is running and available via the **Access Link**. - **Done**. The model is no longer running. -Statuses specific for Fine-tune orders: - -- **Ready**. The new layer is available for download using the **Get Result** button. -- **Done**. The order result is no longer available for download. - Additional possible statuses: - **Canceling**: the order is being canceled by the customer's request. @@ -76,7 +71,7 @@ These buttons are only visible to the user who placed the order. The **Cancel Order** button lets you cancel the order and transfer the remaining balance back to your wallet. Clicking the button initiates the cancellation process by creating a transaction that Web3 users should **Confirm** in MetaMask. If you **Reject** the transaction, the cancellation process will not proceed. - +
### Extend Lease @@ -86,7 +81,7 @@ The **Extend Lease** button opens the **Extend Lease** window that allows you to - For Fine-tune orders, it may be necessary to finish the computation. - For Deploy orders, it increases the time the model will be running. - +

@@ -105,7 +100,7 @@ The **Get Result** button allows you to download a file containing: The **Providers** tab contains additional information about the order and its suborders. - +

@@ -117,7 +112,7 @@ Read more about [order types](/fundamentals/orders). The **Tunnel Orders** tab contains information about tunnel orders related to the main order. The tab is visible only for orders that utilize tunnels. - +

@@ -135,7 +130,7 @@ The **Tunnel Orders** tab contains information about tunnel orders related to th The **Events** tab contains information on what is happening with the order. - +

diff --git a/docs/marketplace/confidentiality.md b/docs/marketplace/confidentiality.md new file mode 100644 index 00000000..58802c61 --- /dev/null +++ b/docs/marketplace/confidentiality.md @@ -0,0 +1,54 @@ +--- +id: "confidentiality" +title: "Check Confidentiality" +slug: "/confidentiality" +sidebar_position: 21 +--- + +*Check Confidentiality* is a service that verifies the authenticity of a domain deployed on Super Protocol and ensures its content is running in a valid Trusted Execution Environment (TEE). + + +
+
+ +Super Protocol uses *SSL/TLS certificates* to encrypt the data exchange between the user's browser and the web server inside the Tunnel Client deployment. Besides, Super Protocol Certification Authorities issue certificates for every order—[*order certificates*](/fundamentals/certification). + +The Check Confidentiality service performs the following: + +- Validates the order certificate chain to ensure the order is being processed in a correct TEE. +- Validates the integrity of the [Tunnel Client](/fundamentals/tunnels) deployment. +- Checks if the solution is a Marketplace offer (for instance, a specific [engine](/marketplace/order-builder#engine)). Otherwise, you will see a warning "Deployed solution is not an offer" meaning the solution cannot be verified. + + +
+
+ +To view the service report, paste the domain URL, for example, **Access Link** available on the [**Order**](/marketplace/all-orders/order) screen of a deployed model. + +## Validation + +The Tunnel Client signs the fingerprint of the domain SSL/TLS certificate with the order certificate's private key. Then, it provides to the Check Confidentiality service: + +- The SSL/TLS certificate fingerprint—the expected fingerprint. +- The fingerprint signature. A valid signature means the Tunnel Client has the private key to the order certificate. +- The order certificate chain to check that all the certificates in the chain have not expired or been revoked. A valid certificate chain means the order is being processed in a correct TEE. + +## Fingerprint comparison + +You can compare the certificate fingerprint with the expected fingerprint, preventing possible man-in-the-middle attacks. + +The Check Confidentiality service displays the expected SSL/TLS certificate signature: + + +
+
+ +To compare the expected SSL/TLS certificate signature with the domain SSL/TLS certificate signature, find the latter in your web browser: + + +
+ + +
+ + \ No newline at end of file diff --git a/docs/marketplace/extras/.index.md b/docs/marketplace/extras/.index.md new file mode 100644 index 00000000..b3964b24 --- /dev/null +++ b/docs/marketplace/extras/.index.md @@ -0,0 +1,6 @@ +--- +id: "extras" +title: "Extras" +slug: "/extras" +sidebar_position: 20 +--- \ No newline at end of file diff --git a/docs/marketplace/release-history/.index.md b/docs/marketplace/extras/.release-history.md similarity index 97% rename from docs/marketplace/release-history/.index.md rename to docs/marketplace/extras/.release-history.md index e2bffa6a..3e59877e 100644 --- a/docs/marketplace/release-history/.index.md +++ b/docs/marketplace/extras/.release-history.md @@ -2,7 +2,7 @@ id: "release-history" title: "Release History" slug: "/release-history" -sidebar_position: 7 +sidebar_position: 22 --- Features coming up in the next phases: diff --git a/docs/marketplace/guides/place-order.md b/docs/marketplace/guides/.place-order.md similarity index 83% rename from docs/marketplace/guides/place-order.md rename to docs/marketplace/guides/.place-order.md index c802e291..8e51d135 100644 --- a/docs/marketplace/guides/place-order.md +++ b/docs/marketplace/guides/.place-order.md @@ -1,6 +1,6 @@ --- id: "place-order" -title: "How to Place an Order" +title: "Place an Order" slug: "/guides/place-order" sidebar_position: 2 --- @@ -23,29 +23,23 @@ Select a model you want to deploy. You can add either a model from the Marketpla - To lease a model listed on the Marketplace, open the list of available **Models** and click the blue **[+]** button next to a model you want to add to the order. + To lease a model listed on the Marketplace, open the list of available **Models** and click the blue **Deploy** button next to a model you want to add to the order. - + - + 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. + When your model is uploaded, open **My Content** and click the blue **Deploy** button next to a model to add it to the order. - + -Once you add a model, open the **Order Builder** by clicking **Order** in the top panel of the Marketplace web app. - - -
-
- -**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). +Once you add a model, you will be redirected to the **Order Builder**. There, you can modify the order's components, configure them, check the prices, and place the order. Read about the [Order Builder](/marketplace/order-builder). ## Step 2. Add an engine @@ -62,7 +56,7 @@ Each engine exists in two variants: Click the blue **[+]** button to add the engine to the order. -If a yellow warning icon appears, it indicates that the selected engine is [incompatible](/marketplace/orders/order-builder/compatibility) with the selected model. Select another engine. +If a yellow warning icon appears, it indicates that the selected engine is [incompatible](/marketplace/order-builder/compatibility) with the selected model. Select another engine. Once you add an engine, you can open its configuration by pressing the **Settings** button. Only make changes if you are confident in what you are doing, as modifying these settings can cause the model to fail to deploy. For more information about the settings, refer to the documentation for [Text Generation Web UI](https://github.com/oobabooga/text-generation-webui/wiki) and [ComfyUI](https://docs.comfy.org/). @@ -96,7 +90,7 @@ Set the desired **Lease Time**. During the testnet, it must be from two to four

-Click the **Checkout** button. The system will check for [compatibility issues](/marketplace/orders/order-builder/compatibility) you need to fix. If there are no issues, the order will proceed to the next step. +Click the **Checkout** button. The system will check for [compatibility issues](/marketplace/order-builder/compatibility) you need to fix. If there are no issues, the order will proceed to the next step. ## Step 5. Confirm transactions @@ -124,7 +118,7 @@ If the MetaMask browser extension does not open automatically, open it manually

-Once the Deploy order is placed successfully, you will be redirected to its [**Order**](/marketplace/orders/order) screen. +Once the Deploy order is placed successfully, you will be redirected to its [**Order**](/marketplace/all-orders/order) screen. ## Step 6. Manage the order diff --git a/docs/marketplace/guides/index.md b/docs/marketplace/guides/index.md index 79e94f32..77f2e31a 100644 --- a/docs/marketplace/guides/index.md +++ b/docs/marketplace/guides/index.md @@ -7,10 +7,8 @@ sidebar_position: 2 | **Guide** | **Description** | | :- | :- | -| [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 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. | \ No newline at end of file +| [Log In as a Web3 user](/marketplace/guides/log-in) | Log in as a Web3 user and set up the account. | +| [Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. | +| [Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. | +| [Set Up Storage](/marketplace/guides/storage) | Set up your personal storage as a Web3 user. | +| [Troubleshooting](/marketplace/guides/troubleshooting) | Fix the most common issues. | \ No newline at end of file diff --git a/docs/marketplace/guides/log-in.md b/docs/marketplace/guides/log-in.md index 2bc85341..f61f8cd0 100644 --- a/docs/marketplace/guides/log-in.md +++ b/docs/marketplace/guides/log-in.md @@ -1,6 +1,6 @@ --- id: "log-in" -title: "How to Log In (Web3)" +title: "Log In as a Web3 user" slug: "/guides/log-in" sidebar_position: 1 --- diff --git a/docs/marketplace/guides/storage.md b/docs/marketplace/guides/storage.md index 54427871..86d39843 100644 --- a/docs/marketplace/guides/storage.md +++ b/docs/marketplace/guides/storage.md @@ -1,6 +1,6 @@ --- id: "storage" -title: "How to Set Up Personal Storage" +title: "Set Up Personal Storage" slug: "/guides/storage" sidebar_position: 6 --- @@ -53,7 +53,7 @@ Select the **Your Storj account** radio button, fill in the fields, and click ** | S3 Access Key (Read) | Access Key with **Read** permission | | S3 Secret Key (Read) | Secret Key with **Read** permissions | - +
## Contact Super Protocol diff --git a/docs/marketplace/guides/troubleshooting.md b/docs/marketplace/guides/troubleshooting.md index b8c7d0f1..666fae57 100644 --- a/docs/marketplace/guides/troubleshooting.md +++ b/docs/marketplace/guides/troubleshooting.md @@ -17,6 +17,8 @@ If the **Enter Marketplace** button is stuck in the loading state, open the Meta If MetaMask shows no requests, refresh the page and press the **Enter Marketplace** button again. +Some wallet extensions may interfere with login attempts. If you have other wallet extensions installed, temporarily switch them off and try to log in again. + If the problem persists, restart your browser and unlock MetaMask before trying to enter the Marketplace. This issue may also occur due to Marketplace maintenance. Wait a few minutes and try again, or contact Super Protocol on [Discord](https://discord.gg/superprotocol) for a quick update. diff --git a/docs/marketplace/guides/upload-comfyui.md b/docs/marketplace/guides/upload-comfyui.md index d4139685..668110e2 100644 --- a/docs/marketplace/guides/upload-comfyui.md +++ b/docs/marketplace/guides/upload-comfyui.md @@ -1,6 +1,6 @@ --- id: "upload-comfyui" -title: "How to Upload a Model (ComfyUI)" +title: "Upload a Model (ComfyUI)" slug: "/guides/upload-comfyui" sidebar_position: 5 --- @@ -42,9 +42,7 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support ### Model size -The size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. - -Note that large models may perform poorly on CPU-only machines without GPU support. If you plan on deploying on CPU, choose a smaller model. +Due to current [testnet limitations](/marketplace/limitations), the size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. ## Step 2. Create a TAR.GZ archive @@ -200,7 +198,7 @@ You can prepare your model manually or using Docker and a script provided by Sup In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the **My Files** screen and press the **Upload File** button. - +

diff --git a/docs/marketplace/guides/upload-tgwui.md b/docs/marketplace/guides/upload-tgwui.md index 970a34fe..7b3a822e 100644 --- a/docs/marketplace/guides/upload-tgwui.md +++ b/docs/marketplace/guides/upload-tgwui.md @@ -1,6 +1,6 @@ --- id: "upload-tgwui" -title: "How to Upload a Model (TGWUI)" +title: "Upload a Model (TGWUI)" slug: "/guides/upload-tgwui" sidebar_position: 4 --- @@ -37,9 +37,7 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support ### Model size -The size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. - -Note that large models may perform poorly on CPU-only machines without GPU support. If you plan on deploying on CPU, choose a smaller model. +Due to current [testnet limitations](/marketplace/limitations), the size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. ## Step 2. Select files @@ -248,7 +246,7 @@ Ensure the model directory contains no hidden files and directories. Archive the In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the **My Files** screen and press the **Upload File** button. - +

diff --git a/docs/marketplace/images/all-orders.png b/docs/marketplace/images/all-orders.png index 0a52f9b6..f56148ae 100644 Binary files a/docs/marketplace/images/all-orders.png and b/docs/marketplace/images/all-orders.png differ diff --git a/docs/marketplace/images/basurero.png b/docs/marketplace/images/basurero.png new file mode 100644 index 00000000..466e43f3 Binary files /dev/null and b/docs/marketplace/images/basurero.png differ diff --git a/docs/marketplace/images/check-confidentiality-connection-1.png b/docs/marketplace/images/check-confidentiality-connection-1.png new file mode 100644 index 00000000..80ed75ee Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-connection-1.png differ diff --git a/docs/marketplace/images/check-confidentiality-connection-2.png b/docs/marketplace/images/check-confidentiality-connection-2.png new file mode 100644 index 00000000..07180cbe Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-connection-2.png differ diff --git a/docs/marketplace/images/check-confidentiality-connection-3.png b/docs/marketplace/images/check-confidentiality-connection-3.png new file mode 100644 index 00000000..ca0fe767 Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-connection-3.png differ diff --git a/docs/marketplace/images/check-confidentiality-fingerprint.png b/docs/marketplace/images/check-confidentiality-fingerprint.png new file mode 100644 index 00000000..99823539 Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-fingerprint.png differ diff --git a/docs/marketplace/images/check-confidentiality-menu.png b/docs/marketplace/images/check-confidentiality-menu.png new file mode 100644 index 00000000..4f3412c3 Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-menu.png differ diff --git a/docs/marketplace/images/check-confidentiality-not-found.png b/docs/marketplace/images/check-confidentiality-not-found.png new file mode 100644 index 00000000..c9ffcc8e Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-not-found.png differ diff --git a/docs/marketplace/images/check-confidentiality-not-offer.png b/docs/marketplace/images/check-confidentiality-not-offer.png new file mode 100644 index 00000000..ee9aa8fa Binary files /dev/null and b/docs/marketplace/images/check-confidentiality-not-offer.png differ diff --git a/docs/marketplace/images/check-confidentiality.png b/docs/marketplace/images/check-confidentiality.png new file mode 100644 index 00000000..4701e6eb Binary files /dev/null and b/docs/marketplace/images/check-confidentiality.png differ diff --git a/docs/marketplace/images/confirm-transactions-error.png b/docs/marketplace/images/confirm-transactions-error.png index 8be81ba9..74e8e67d 100644 Binary files a/docs/marketplace/images/confirm-transactions-error.png and b/docs/marketplace/images/confirm-transactions-error.png differ diff --git a/docs/marketplace/images/demo-account.png b/docs/marketplace/images/demo-account.png deleted file mode 100644 index 9e6a66ba..00000000 Binary files a/docs/marketplace/images/demo-account.png and /dev/null differ diff --git a/docs/marketplace/images/deploy-models.png b/docs/marketplace/images/deploy-models.png new file mode 100644 index 00000000..70113ed5 Binary files /dev/null and b/docs/marketplace/images/deploy-models.png differ diff --git a/docs/marketplace/images/deploy-my-content.png b/docs/marketplace/images/deploy-my-content.png new file mode 100644 index 00000000..20e0cd0b Binary files /dev/null and b/docs/marketplace/images/deploy-my-content.png differ diff --git a/docs/marketplace/images/edit-content.png b/docs/marketplace/images/edit-content.png index f8e9b159..863db746 100644 Binary files a/docs/marketplace/images/edit-content.png and b/docs/marketplace/images/edit-content.png differ diff --git a/docs/marketplace/images/enter-marketplace-button.png b/docs/marketplace/images/enter-marketplace-button.png index ee94e153..9ed03485 100644 Binary files a/docs/marketplace/images/enter-marketplace-button.png and b/docs/marketplace/images/enter-marketplace-button.png differ diff --git a/docs/marketplace/images/marketplace-models-menu.png b/docs/marketplace/images/marketplace-models-menu.png deleted file mode 100644 index 681abebf..00000000 Binary files a/docs/marketplace/images/marketplace-models-menu.png and /dev/null differ diff --git a/docs/marketplace/images/marketplace-order-builder.png b/docs/marketplace/images/marketplace-order-builder.png deleted file mode 100644 index abf245d4..00000000 Binary files a/docs/marketplace/images/marketplace-order-builder.png and /dev/null differ diff --git a/docs/marketplace/images/marketplace-web3acc-menu.png b/docs/marketplace/images/marketplace-web3acc-menu.png index dc3b0068..d0213d78 100644 Binary files a/docs/marketplace/images/marketplace-web3acc-menu.png and b/docs/marketplace/images/marketplace-web3acc-menu.png differ diff --git a/docs/marketplace/images/marketplace-web3acc.png b/docs/marketplace/images/marketplace-web3acc.png index 073739d0..bce7e05b 100644 Binary files a/docs/marketplace/images/marketplace-web3acc.png and b/docs/marketplace/images/marketplace-web3acc.png differ diff --git a/docs/marketplace/images/mas.png b/docs/marketplace/images/mas.png new file mode 100644 index 00000000..f3d3076a Binary files /dev/null and b/docs/marketplace/images/mas.png differ diff --git a/docs/marketplace/images/models-table.png b/docs/marketplace/images/models-table.png index e945a67e..451ddbae 100644 Binary files a/docs/marketplace/images/models-table.png and b/docs/marketplace/images/models-table.png differ diff --git a/docs/marketplace/images/models-tiles.png b/docs/marketplace/images/models-tiles.png index d23475b5..db2af2b5 100644 Binary files a/docs/marketplace/images/models-tiles.png and b/docs/marketplace/images/models-tiles.png differ diff --git a/docs/marketplace/images/my-content-upload.png b/docs/marketplace/images/my-content-upload.png new file mode 100644 index 00000000..2f4ed951 Binary files /dev/null and b/docs/marketplace/images/my-content-upload.png differ diff --git a/docs/marketplace/images/my-content.png b/docs/marketplace/images/my-content.png new file mode 100644 index 00000000..e76967ec Binary files /dev/null and b/docs/marketplace/images/my-content.png differ diff --git a/docs/marketplace/images/my-files-menu.png b/docs/marketplace/images/my-files-menu.png deleted file mode 100644 index 7aa52880..00000000 Binary files a/docs/marketplace/images/my-files-menu.png and /dev/null differ diff --git a/docs/marketplace/images/my-files-upload.png b/docs/marketplace/images/my-files-upload.png deleted file mode 100644 index 74a9bf6c..00000000 Binary files a/docs/marketplace/images/my-files-upload.png and /dev/null differ diff --git a/docs/marketplace/images/my-files.png b/docs/marketplace/images/my-files.png deleted file mode 100644 index ff8d6c12..00000000 Binary files a/docs/marketplace/images/my-files.png and /dev/null differ diff --git a/docs/marketplace/images/offer-about.png b/docs/marketplace/images/offer-about.png index 207ce6e0..dcc5f900 100644 Binary files a/docs/marketplace/images/offer-about.png and b/docs/marketplace/images/offer-about.png differ diff --git a/docs/marketplace/images/offer-added.png b/docs/marketplace/images/offer-added.png deleted file mode 100644 index f7d5b7a6..00000000 Binary files a/docs/marketplace/images/offer-added.png and /dev/null differ diff --git a/docs/marketplace/images/offer-pricing.png b/docs/marketplace/images/offer-pricing.png index c26b1950..01ad9eff 100644 Binary files a/docs/marketplace/images/offer-pricing.png and b/docs/marketplace/images/offer-pricing.png differ diff --git a/docs/marketplace/images/order-builder-compute.png b/docs/marketplace/images/order-builder-compute.png deleted file mode 100644 index 9ddf1995..00000000 Binary files a/docs/marketplace/images/order-builder-compute.png and /dev/null differ diff --git a/docs/marketplace/images/order-builder-engine-settings.png b/docs/marketplace/images/order-builder-engine-settings.png index ccd5aee3..6cbba1c7 100644 Binary files a/docs/marketplace/images/order-builder-engine-settings.png and b/docs/marketplace/images/order-builder-engine-settings.png differ diff --git a/docs/marketplace/images/order-builder-engine.png b/docs/marketplace/images/order-builder-engine.png deleted file mode 100644 index a8ac8d98..00000000 Binary files a/docs/marketplace/images/order-builder-engine.png and /dev/null differ diff --git a/docs/marketplace/images/order-builder-footer.png b/docs/marketplace/images/order-builder-footer.png index e5afd0fb..5099501f 100644 Binary files a/docs/marketplace/images/order-builder-footer.png and b/docs/marketplace/images/order-builder-footer.png differ diff --git a/docs/marketplace/images/order-builder.png b/docs/marketplace/images/order-builder.png index 28aab2ee..2694e8a5 100644 Binary files a/docs/marketplace/images/order-builder.png and b/docs/marketplace/images/order-builder.png differ diff --git a/docs/marketplace/images/upload-content-done.png b/docs/marketplace/images/upload-content-done.png index 118764e9..36fe54a4 100644 Binary files a/docs/marketplace/images/upload-content-done.png and b/docs/marketplace/images/upload-content-done.png differ diff --git a/docs/marketplace/images/upload-content.png b/docs/marketplace/images/upload-content.png index 388a99e0..b2982f60 100644 Binary files a/docs/marketplace/images/upload-content.png and b/docs/marketplace/images/upload-content.png differ diff --git a/docs/marketplace/images/web2-account.png b/docs/marketplace/images/web2-account.png new file mode 100644 index 00000000..528db2d7 Binary files /dev/null and b/docs/marketplace/images/web2-account.png differ diff --git a/docs/marketplace/images/web3-account.png b/docs/marketplace/images/web3-account.png index ef337444..46480abe 100644 Binary files a/docs/marketplace/images/web3-account.png and b/docs/marketplace/images/web3-account.png differ diff --git a/docs/marketplace/images/web3-storage.png b/docs/marketplace/images/web3-storage.png new file mode 100644 index 00000000..4cdd08ee Binary files /dev/null and b/docs/marketplace/images/web3-storage.png differ diff --git a/docs/marketplace/images/web3acc-storj.png b/docs/marketplace/images/web3acc-storj.png deleted file mode 100644 index 1f98b4a5..00000000 Binary files a/docs/marketplace/images/web3acc-storj.png and /dev/null differ diff --git a/docs/marketplace/index.md b/docs/marketplace/index.md index 481f0eac..792c6067 100644 --- a/docs/marketplace/index.md +++ b/docs/marketplace/index.md @@ -7,23 +7,23 @@ sidebar_position: 0 [Super Protocol](https://superprotocol.com/) is an AI cloud and Marketplace based on the principles of confidentiality, decentralization, and self-sovereignty. In the Super Protocol cloud, confidential computing technology protects data during execution, while blockchain-based decentralized networks provide orchestration, transparency, and verifiability of all processes. -Super Protocol launched Marketplace 1.0 in 2022 with limited capabilities, supporting only Intel SGX CPUs. Now, the company is developing Marketplace 2.0 with a full range of capabilities, support for Intel TDX CPU and NVIDIA H100 GPU confidential computing, and a specific focus on confidential AI fine-tuning and deployments. +Super Protocol launched Marketplace 1.0 in 2022 with limited capabilities, supporting only Intel SGX CPUs. Now, the company is developing [Marketplace 2.0](https://marketplace.superprotocol.com/) with a full range of capabilities, support for Intel TDX CPU and NVIDIA H100 GPU confidential computing, and a specific focus on confidential AI fine-tuning and deployments. -Super Protocol launched the first public release of [Marketplace 2.0](https://marketplace.superprotocol.com/) on November 27, 2024. It includes the following capabilities: +Super Protocol launched the first public release of Marketplace 2.0 on November 27, 2024. It includes the following capabilities: -- Demo account with OAuth2 login for a quick start -- Support for Intel TDX and NVIDIA GPU confidential computing -- Ability to upload model files to the Super Cloud or personal Storj accounts -- AI model deployment in confidential tunnels using various AI engines and settings -- Redesigned UI/UX +- Demo account with OAuth2 login for a quick start. +- Support for Intel TDX and NVIDIA GPU confidential computing. +- Ability to upload model files to the Super Cloud or personal Storj accounts. +- AI model deployment in confidential tunnels using various AI engines and settings. +- Redesigned UI/UX. Upcoming features in the future development phases: -- Publishing offers in the Marketplace from uploaded files -- Fine-tuning models by creating new layers for base models -- Support for datasets -- Expanded model availability in the Marketplace -- Additional AI engines and support for more model categories -- A light UI theme +- Publishing offers in the Marketplace from uploaded files. Currently, publishing is limited to selected researchers, testers, and developers. +- Fine-tuning models by creating new layers for base models. +- Support for datasets. +- Expanded model availability in the Marketplace. +- Additional AI engines and support for more model categories. +- A light UI theme. Any feedback would be very much appreciated—please join our [Discord](https://discord.gg/superprotocol) or use the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new). diff --git a/docs/marketplace/limitations.md b/docs/marketplace/limitations.md index d9ab2fbf..840e002e 100644 --- a/docs/marketplace/limitations.md +++ b/docs/marketplace/limitations.md @@ -22,27 +22,27 @@ Pricing and restrictions: - Order lease time: minimum 2 hours. - Compute costs 0.2126 SPPI tokens per hour in most cases. -- Models from the Marketplace cost 0 SPPI per order. +- Currently, models from the Marketplace cost 0 SPPI per order. - Engines cost 0 SPPI per order. -- Setting up a confidential tunnel costs 0.1 SPPI per order or less. +- Setting up a confidential tunnel costs 0.1-0.2 SPPI per order. For example, a two-hour GPU-order would cost: -0.2126 x 2 + ~0.1 = **0.5252 SPPI** tokens. +0.2126 x 2 + ~0.15 = **~0.5752 SPPI** tokens. -The total gas fee varies, but it is approximately **0.00001 BNB** per order. +The total gas fee varies, but usually, it is about **0.00001 BNB** per order. ## Token limits -Web3 users can receive up to **5 SPPI** tokens and **0.0001 BNB** tokens daily. +Web3 users can receive up to **1.5 SPPI** tokens and **0.0001 BNB** tokens daily. ## Model limits -The total size of your model files should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. +If you want to upload and deploy your model, its total size should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. Also, deployed models must belong to a category supported by one of the AI engines: -- **Text Generation Web UI** supports models that involve text-based chats: +- **Text Generation Web UI** supports text-based tasks: + Text Generation + Text Classification + Translation @@ -57,4 +57,4 @@ Also, deployed models must belong to a category supported by one of the AI engin + Image-to-Video + Video Classification + Text-to-Video - + Mask Generation \ No newline at end of file + + Mask Generation diff --git a/docs/marketplace/marketplace/index.md b/docs/marketplace/marketplace/index.md deleted file mode 100644 index 99fd38bc..00000000 --- a/docs/marketplace/marketplace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: "marketplace" -title: "Marketplace" -slug: "/marketplace" -sidebar_position: 4 ---- - -**Marketplace** contains **Models** and **Datasets** offered for lease. - -| **Document** | **Description** | -| :- | :- | -| [Models/Datasets](/marketplace/marketplace/list) | The **Models** and **Datasets** screens display lists of available offers. | -| [Offer](/marketplace/marketplace/offer) | The **Offer** window contains detailed information about an offer. | \ No newline at end of file diff --git a/docs/marketplace/marketplace/offer.md b/docs/marketplace/marketplace/offer.md deleted file mode 100644 index 23006395..00000000 --- a/docs/marketplace/marketplace/offer.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: "offer" -title: "Offer" -slug: "/marketplace/offer" -sidebar_position: 2 ---- - -This window provides detailed information about a model or dataset available for lease on the Marketplace. - - -
- -## Metadata - -On the right side of the window, you can see the offer's metadata: - -- **Offer ID**: a unique offer identification number. It is incremental and continuous for model offers and dataset offers. -- **Offer Type**: the type of the offer, either **Model**, **Dataset**, **Engine**, or **Compute**. -- **Category**: the types of tasks that the model or dataset is designed to perform. Models can only belong to one category; datasets may belong to several categories. -- **Provider**: the name of the provider that created the offer. -- **Published**: the date and time when the offer was created. -- **Updated**: the date and time of the latest offer update. - -## About tab - -The **About** tab displays the general description of the offer's content given by its provider. - -## Pricing tab - -The **Pricing** tab contains the offer requirements, detailing how many confidential computing resources the offer needs. - - -
-
- -- Pricing type and cost in SPPI tokens: - + **Fixed** indicates you must pay only once to lease the offer, regardless of the lease duration. - + **Per Hour** indicates you must pay for each hour of leasing the offer. -- **CPU vCores**: number of CPU cores, can be fractional. -- **CPU RAM**: amount of RAM in gigabytes (GB). -- **GPU vCores**: number of GPU cores, can be fractional. -- **GPU RAM**: amount of video RAM in gigabytes (GB). -- **Disk**: disk space in gigabytes (GB). -- **Bandwidth**: data transfer rate in megabits per second (Mbps). -- **Traffic**: amount of traffic in gigabytes (GB). -- **Ext.Port**: availability of an external port for internet access; either **Yes** or **Any**. -- **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. 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: - - \ No newline at end of file diff --git a/docs/marketplace/marketplace/list.md b/docs/marketplace/models/index.md similarity index 58% rename from docs/marketplace/marketplace/list.md rename to docs/marketplace/models/index.md index 49141ab3..cfbf8a04 100644 --- a/docs/marketplace/marketplace/list.md +++ b/docs/marketplace/models/index.md @@ -1,11 +1,11 @@ --- -id: "list" -title: "Models/Datasets" -slug: "/marketplace/list" -sidebar_position: 1 +id: "models" +title: "Models" +slug: "/models" +sidebar_position: 4 --- -This screen lists models or datasets offered on the Marketplace. You can lease the content listed here by adding it to your orders. Read [How to Place an Order](/marketplace/guides/place-order) for step-by-step instructions. +This screen lists models or datasets offered on the Marketplace. You can lease the content listed here by adding it to your orders. :::note @@ -18,7 +18,7 @@ Datasets are not yet available in the current version of the Marketplace. ## Offers -To add a model or dataset to an order, click the blue **[+]** button next to it. +To deploy a model, click the blue **Deploy** button next to it. You can view the list as either tiles or a table. The buttons in the top-right corner allow you to sort offers, switch between views, and customize table columns. The same list in the table view: @@ -34,13 +34,21 @@ In the table view, you can see the following columns: - **Price, hr**: the hourly rate for leasing the offer. - **Price, fix**: the fixed price for each use of the offer, regardless of the lease duration. -Clicking an offer opens the [**Offer**](/marketplace/marketplace/offer) window, which provides further details such as descriptions, requirement slots, and pricing. +Clicking an offer opens the [**Offer**](/marketplace/models/offer) window, which provides further details such as descriptions, requirement slots, and pricing. -## Filters +## Filters and search -Use the filters on the left side of the screen to narrow down the list and quickly find specific offers. +Use the search bar above the list of offers to find an offer by its name or ID. -In the current version of the Marketplace, you can only filter by the category—the type of task that models are designed to perform: +To clear the search results and set filters to default values, click **Reset filters** on the left side of the screen. + +**Offers** filters by the verification status: + +- **All**: shows all offers. +- **Verified**: only shows offers that passed the initial check and can be deployed. Note that this status does not mean the model works well; it just indicates that the model can be deployed successfully. +- **Unsorted**: only shows offers that have yet to pass the initial check. + +**Category** filters by the type of task that models are designed to perform: - Image Classification - Image Segmentation diff --git a/docs/marketplace/models/offer.md b/docs/marketplace/models/offer.md new file mode 100644 index 00000000..a8c42070 --- /dev/null +++ b/docs/marketplace/models/offer.md @@ -0,0 +1,70 @@ +--- +id: "offer" +title: "Offer" +slug: "/models/offer" +sidebar_position: 2 +--- + +This window provides information about a model available for lease on the Marketplace, including its pricing and requirements. + + +
+ +## Metadata + +On the right-hand side of the window, you can find metadata about the offer: + +- **Offer ID**: a unique identifier; it is incremental and continuous across model and dataset offers. +- **Offer Type**: the type of the offer: + + **Model** + + **Dataset** + + **Engine** + + **Compute**. +- **Provider**: name of the provider that created the offer. +- **Category**: the tasks the model or dataset is intended for. +- **Source**: link to the resource from which the model was taken. +- **Published**: date and time when the offer was created. +- **Updated**: date and time of the most recent update. + +## About tab + +The **About** tab displays the general description of the offer's content given by its provider. + +## Pricing tab + +The **Pricing** tab contains the cost of leasing the model and details about how many confidential computing resources the offer requires. + + +
+ +**Model Format** allows you to change the model format if others are available. + +### Slots + +The offer provider can configure multiple sets of requirements called *[slots](/fundamentals/slots#requirements)*. Each slot may have a different price based on expected usage—higher workload typically imply higher pricing. + +Slots may be divided into two categories: + +- For GPU: run the model on an NVIDIA H100 Tensor Core GPU. +- For CPU: run the model on an Intel TDX CPU. Note that the model may run slower in this mode. However, it may be a suitable way to deploy smaller models since the TDX-only machines are cheaper and has more availability than TDX+H100 machines. + +Super Protocol supports two pricing types: + +- **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. + +Each slot includes the following requirements: + +- **CPU vCores**: number of CPU cores; can be fractional. +- **CPU RAM**: RAM in gigabytes (GB). +- **GPU vCores**: number of GPU cores; can be fractional. +- **GPU RAM**: video RAM in gigabytes (GB). +- **Disk**: disk space in gigabytes (GB). +- **Bandwidth**: data transfer rate in megabits per second (Mbps). +- **Traffic**: total allowed data transfer usage in gigabytes (GB). +- **Ext.Port**: availability of an external port for internet access; either **Yes** or **Any**. +- **Min Time** and **Max Time**: minimum and maximum lease duration limits, as defined by the provider. + +The **slotID**, shown in the bottom-right corner of each slot, is a unique identifier. These IDs are incremental and continuous across model and dataset offers. + +To add the offer to your order, click the blue **Deploy** button next to the desired slot. \ No newline at end of file diff --git a/docs/marketplace/my-content/index.md b/docs/marketplace/my-content/index.md deleted file mode 100644 index 5373f3b3..00000000 --- a/docs/marketplace/my-content/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: "my-content" -title: "My Content" -slug: "/my-content" -sidebar_position: 5 ---- - -**My Content** contains **My Files** with your uploaded files and **My Offers** with your offers created from the uploaded files. - -:::note - -Registering providers and creating offers are not yet available in the current version of the Marketplace. - -::: - -## Table of contents - -| **Document** | **Description** | -| :- | :- | -| [My Files](/marketplace/my-content/my-files) | The **My Files** screen displays the list of your uploaded files. | -| [Upload Content](/marketplace/my-content/my-files/upload-content) | The **Upload Content** window allows uploading files to Super Protocol. | -| [Info](/marketplace/my-content/my-files/info) | The **Info** window displays the information about an uploaded file. | -| [Edit Content](/marketplace/my-content/my-files/upload-content) | The **Edit Content** window allows editing the information about an uploaded file. | -| [My Offers](/marketplace/my-content/my-offers) | The **My Offers** screen displays the list of your offers. | \ No newline at end of file diff --git a/docs/marketplace/my-content/my-offers/index.md b/docs/marketplace/my-content/my-offers/index.md deleted file mode 100644 index fcb2e2fe..00000000 --- a/docs/marketplace/my-content/my-offers/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: "my-offers" -title: "My Offers" -slug: "/my-content/my-offers" -sidebar_position: 2 ---- - -In future releases, the **My Offers** screen will allow you to manage your offers created from uploaded models and datasets. - -:::note - -Creating offers is not yet available in the current version of the Marketplace. - -::: \ No newline at end of file diff --git a/docs/marketplace/my-content/my-files/edit-content.md b/docs/marketplace/my-offers/edit-content.md similarity index 81% rename from docs/marketplace/my-content/my-files/edit-content.md rename to docs/marketplace/my-offers/edit-content.md index 5db1fdae..1b128396 100644 --- a/docs/marketplace/my-content/my-files/edit-content.md +++ b/docs/marketplace/my-offers/edit-content.md @@ -1,13 +1,13 @@ --- id: "edit-content" title: "Edit Content" -slug: "/my-content/my-files/edit-content" +slug: "/my-offers/edit-content" sidebar_position: 4 --- Use this window to change the metadata of the uploaded content. - +

diff --git a/docs/marketplace/my-content/my-files/index.md b/docs/marketplace/my-offers/index.md similarity index 59% rename from docs/marketplace/my-content/my-files/index.md rename to docs/marketplace/my-offers/index.md index e485b88b..a8d3dd97 100644 --- a/docs/marketplace/my-content/my-files/index.md +++ b/docs/marketplace/my-offers/index.md @@ -1,8 +1,8 @@ --- -id: "my-files" -title: "My Files" -slug: "/my-content/my-files" -sidebar_position: 1 +id: "my-offers" +title: "My Content" +slug: "/my-offers" +sidebar_position: 5 --- This screen allows you to manage your uploaded models and datasets. @@ -13,26 +13,26 @@ Datasets are not yet available in the current version of the Marketplace. ::: - +

-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 **Upload File** button opens the [**Upload Content**](/marketplace/my-offers/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). +- **Size**: file size of the file in gigabytes. For the exact size in bytes, check the file's [**Info**](/marketplace/my-offers/info). - **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. +To deploy a model, click the blue **Deploy** button next to it. For more actions, click the buttons with three vertical dots next to a file to open the content's management menu: -- [**Info**](/marketplace/my-content/my-files/info): view detailed information about the uploaded content. -- [**Edit**](/marketplace/my-content/my-files/edit-content): edit the content's metadata, such as name, type, categories, etc. +- [**Info**](/marketplace/my-offers/info): view detailed information about the uploaded content. +- [**Edit**](/marketplace/my-offers/edit-content): edit the content's metadata, such as name, type, categories, etc. - **Create offer**: create an offer using the uploaded content (not yet implemented). - **Delete content**: delete the uploaded content from the storage. \ No newline at end of file diff --git a/docs/marketplace/my-content/my-files/info.md b/docs/marketplace/my-offers/info.md similarity index 89% rename from docs/marketplace/my-content/my-files/info.md rename to docs/marketplace/my-offers/info.md index 9c6e5b18..f82fe7ef 100644 --- a/docs/marketplace/my-content/my-files/info.md +++ b/docs/marketplace/my-offers/info.md @@ -1,13 +1,13 @@ --- id: "info" title: "Info" -slug: "/my-content/my-files/info" +slug: "/my-offers/info" sidebar_position: 2 --- This window contains information about the uploaded file. - +

diff --git a/docs/marketplace/my-content/my-files/upload-content.md b/docs/marketplace/my-offers/upload-content.md similarity index 91% rename from docs/marketplace/my-content/my-files/upload-content.md rename to docs/marketplace/my-offers/upload-content.md index 604a8350..374cc3bb 100644 --- a/docs/marketplace/my-content/my-files/upload-content.md +++ b/docs/marketplace/my-offers/upload-content.md @@ -1,7 +1,7 @@ --- id: "upload-content" title: "Upload Content" -slug: "/my-content/my-files/upload-content" +slug: "/my-offers/upload-content" sidebar_position: 1 --- @@ -10,7 +10,7 @@ Use this window to upload models. Uploading models is necessary to deploy and ru - Upload datasets and use them to fine-tune models. - Create offers to lease your uploaded models and datasets to other users. - +

diff --git a/docs/marketplace/orders/order-builder/checkout.md b/docs/marketplace/order-builder/checkout.md similarity index 55% rename from docs/marketplace/orders/order-builder/checkout.md rename to docs/marketplace/order-builder/checkout.md index 8b2d850b..d20f4c31 100644 --- a/docs/marketplace/orders/order-builder/checkout.md +++ b/docs/marketplace/order-builder/checkout.md @@ -1,35 +1,32 @@ --- id: "checkout" title: "Confirm Transactions" -slug: "/orders/order-builder/checkout" +slug: "/order-builder/checkout" sidebar_position: 2 --- This window informs you about the creation of transactions on the blockchain, which is the final step in placing an order. - +

-Before your order can be processed, you must pay the initial order deposit. [**Order Builder**](/marketplace/orders/order-builder) shows this amount as **Pay Now** before the checkout. +Before your order can be processed, you must pay the initial order deposit. [**Order Builder**](/marketplace/order-builder) shows this amount as **Pay Now** before the checkout. 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. - **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: +Note that **Deploy** orders require confirmation of two transactions—one to pay for the Tunnels Launcher order and another for the main (Deploy) order. Tunnels Launcher creates a set of [confidential tunnels](/fundamentals/tunnels) necessary to access the running model from the internet. -- **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. +Once the order is placed successfully, you will be redirected to its [**Order**](/marketplace/all-orders/order) screen. ## Handle errors If an error occurs during transaction confirmation, you will see the error message in this window and a notification in the bottom-right corner of the screen. - +

diff --git a/docs/marketplace/orders/order-builder/compatibiity.md b/docs/marketplace/order-builder/compatibiity.md similarity index 71% rename from docs/marketplace/orders/order-builder/compatibiity.md rename to docs/marketplace/order-builder/compatibiity.md index 0a87c881..7017c404 100644 --- a/docs/marketplace/orders/order-builder/compatibiity.md +++ b/docs/marketplace/order-builder/compatibiity.md @@ -1,7 +1,7 @@ --- id: "compatibility" title: "Compatibility Issues" -slug: "/orders/order-builder/compatibility" +slug: "/order-builder/compatibility" sidebar_position: 1 --- @@ -11,21 +11,21 @@ This window informs you about issues with your order. You must fix them before y This message appears when the selected model and a dataset do not belong to the same category. An example of such a message: - +
## Not compatible with the engine This message appears when the selected model or dataset belongs to a category that the engine does not support. An example of such a message: - +
## Compute configuration is not sufficient This message appears when the selected compute configuration does not meet the combined requirements of the models, datasets, and engine added to the order. - +

@@ -35,11 +35,11 @@ Ensure your order fits into the total maximum compute configuration allowed for This message appears if the lease time entered before checkout is either too short or too long. An example of such a message: - +

-Providers can define minimum and maximum lease time limits for their offers. To check these limits, go to the [**Pricing** tab](/marketplace/marketplace/offer#pricing-tab) in the **Offer** window. If the order lease time is outside these limits, the order cannot proceed. +Providers can define minimum and maximum lease time limits for their offers. To check these limits, go to the [**Pricing** tab](/marketplace/models/offer#pricing-tab) in the **Offer** window. If the order lease time is outside these limits, the order cannot proceed. For example, you add offers with the following lease time limitations: diff --git a/docs/marketplace/order-builder/index.md b/docs/marketplace/order-builder/index.md new file mode 100644 index 00000000..34efaa05 --- /dev/null +++ b/docs/marketplace/order-builder/index.md @@ -0,0 +1,128 @@ +--- +id: "order-builder" +title: "Order Builder" +slug: "/order-builder" +sidebar_position: 7 +--- + +_Order Builder_ is a tool to configure deployment orders for AI models. Deployment orders consist of three main components: + +- **Model** +- **Engine** +- **Compute** + + +
+ +## Model + +If no model is currently added to the Order Builder, go to the **Marketplace** or **My Content** using the links and click the **Deploy** button next to the desired model. This will add the model to the order along with automatically selected engine and compute offers. + +If the model offer has multiple [requirement slots](/fundamentals/slots), the **Deploy** button adds the first slot configured for GPU deployment. To deploy the model on CPU, click the model's name to open its [**Offer**](/marketplace/models/offer) window, go to the **Pricing** tab, and click the button next to the desired slot. + +To view the model's selected slot, expand the **Requirements**. If you add your uploaded model to the order, its requirements are not specified. The system does not include such models in the automatic calculation of the compute configuration. + +:::warning + +Ensure your uploaded model fits into the maximum compute configuration [allowed for the testnet](/marketplace/limitations), or it may fail to deploy correctly. + +::: + +## Engine + +The term _engine_ refers to the software necessary to deploy models and provide a web UI. + +Currently, Super Protocol supports two AI engines: + +- **Text Generation Web UI** for text-to-text models. +- **ComfyUI** for image- and video-related tasks. + +The Super Protocol team will add more popular open-source AI engines in the future. User-uploaded engines are not yet allowed as they may have built-in vulnerabilities. + +A suitable engine offer is automatically added to the order once you add a model. To select another engine, remove the suggested one and select the desired engine offer from the list. + +Clicking the engine's name opens its [**Offer**](/marketplace/models/offer) window. + +You can configure the added engine by pressing the **Settings** button. Only make changes if you are confident in what you are doing, as modifying these settings can cause the model to fail to deploy. For more information about the settings, refer to the [Text Generation Web UI](https://github.com/oobabooga/text-generation-webui/wiki) and [ComfyUI](https://docs.comfy.org/) documentation. + + +
+ +### API mode + +When deploying a model with Text Generation Web UI (TGWUI), you can run the engine in the API mode. TGWUI uses an OpenAI-compatible API that is private, does not create logs, and does not connect to OpenAI. + +To deploy a model in the API mode, tick the **api** checkbox in the engine settings and set the API authentication keys. Note that GUI will not start in this mode. + +API requests must include the deployed model's domain on Super Protocol and the API authentication key: + +```bash +curl "" \ +-H "Authorization: Bearer " \ +-H "Content-Type: application/json" +``` + +Where: + +- `` is a web UI access link with the API endpoint. The access link is available on the [**Order**](/marketplace/all-orders/order) screen when the model is deployed. The API endpoint can be `/v1/completions` or `/v1/chat/completions`; check the full list of compatible endpoints in the [TGWUI documentaion](https://github.com/oobabooga/text-generation-webui/wiki/12-%E2%80%90-OpenAI-API#compatibility--not-so-compatibility). +- `` is the API authentication key set in the engine settings. + +An example of an API request: + +```bash +curl https://crow-prs-coma.superprotocol.io/v1/chat/completions \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer authkey123" \ + -d '{ + "messages": [{"role": "user", "content": "What is confidential computing?"}], + "mode": "instruct", + "instruction_template": "Alpaca", + "max_tokens": 300, + "temperature": 0.8, + "top_p": 0.95 + }' +``` + +Refer to the [Text Generation Web UI API documentation](https://github.com/oobabooga/text-generation-webui/wiki/12-%E2%80%90-OpenAI-API) to learn more. + +### Tunnels + +Placing a deployment order also places an order for a [confidential tunnel](https://docs.superprotocol.com/fundamentals/tunnels) to access the engine's web UI via HTTPS. The engine settings include the **Tunnels** tab with **Domain Settings**: + +- **Temporary Domain** uses pre-configured settings to create a domain on `superprotocol.io` with a randomly generated name, for example, `mund-avys-kefs.superprotocol.io`. It is the recommended option that does not require additional setup. +- **Manual Configuration** will allow advanced users to host a model on a custom domain. This feature is not yet available. + +## Compute + +The term _compute_ refers to a confidential computing machine that processes the order. + +A suitable compute offer is automatically added to the order once you add a model or engine based on the combined requirements of the selected model and engine. To select another compute, remove the suggested one and select the desired compute offer from the list. + +The system automatically calculates a [compute configuration](/fundamentals/slots#configuration) that meets or exceeds the combined requirements of the model and engine added to the order. + +**In Queue** shows the number of orders waiting for an empty slot on this machine. If the number is greater than zero, your order may take longer to process. Consider choosing another compute offer. + +Clicking the machine's name opens its [**Offer**](/marketplace/models/offer) window. + + +
+ +## Checkout + +The panel at the bottom of the screen lets you set the desired lease time and confirm total costs before checkout. + +**Fixed** is the total for all fixed-price offers, including the cost of creating a tunnel. You will pay this sum immediately after placing the order. + +**Per Hour** is the total for all hourly-priced offers, including the cost of creating a tunnel. This sum will be gradually deducted from the order deposit for each hour the order is running. + +**Lease Time** allows you to set the duration for which the order will run. Increasing the lease time raises the initial deposit amount. + +Providers may limit the minimum and maximum allowed lease time for their offers. You will see a warning if the lease time you enter is outside these limits. + +**Pay now** shows the initial order deposit you must pay at checkout. It is calculated using the following formula: + +**Pay now** = **Per Hour** x **Lease Time** + **Fixed** + +You can increase the deposit now by increasing the **Lease Time** or after checkout while the order is processing. + +The blue **Pay Now** button opens the [**Confirm Transactions**](/marketplace/order-builder/checkout) window, informing you about creating blockchain transactions. \ No newline at end of file diff --git a/docs/marketplace/orders/index.md b/docs/marketplace/orders/index.md deleted file mode 100644 index 39177d4d..00000000 --- a/docs/marketplace/orders/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: "orders" -title: "Orders" -slug: "/orders" -sidebar_position: 6 ---- - -This section contains documentation related to creating and managing orders. - -| **Document** | **Description** | -| :- | :- | -| [Order Builder](/marketplace/orders/order-builder) | Order Builder is a tool to pick the order's components, configure them, calculate prices, and place orders. | -| [Compatibility Issues](/marketplace/orders/order-builder/compatibility) | Read about the possible issues with the order's component during checkout. | -| [Checkout](/marketplace/orders/order-builder/checkout) | The **Checkout** window informs you about transactions created during checkout. | -| [All Orders](/marketplace/orders/all-orders) | The **All Orders** screen contains the full list of all your created orders. | -| [Order](/marketplace/orders/order) | The **Order** screen provides detailed information about a particular order. | \ No newline at end of file diff --git a/docs/marketplace/orders/order-builder/index.md b/docs/marketplace/orders/order-builder/index.md deleted file mode 100644 index 31493bd3..00000000 --- a/docs/marketplace/orders/order-builder/index.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: "order-builder" -title: "Order Builder" -slug: "/orders/order-builder" -sidebar_position: 1 ---- - -Order Builder is a tool to configure orders from the main components: - -- **Models** -- **Datasets** -- **Engine** -- **Compute** - -Read [How to Place an Order](/marketplace/guides/place-order) for step-by-step instructions. - - -
- -## Order Type - -Super Protocol supports two types of orders: - -- **Fine-tune** is an order to customize a pre-trained model for a specific purpose by creating an additional layer. This type of order performs a computation and generates a result. Once the order is complete, you can download the result as a file. -- **Deploy** is an order to run a pre-trained model with a web interface. The model is accessible from the internet via secure [confidential tunnels](/fundamentals/tunnels) deployed automatically by a separate order. The model continues to run as long as the order balance remains positive, without a set end time. - -:::note - -Fine-tune orders are not yet available in the current version of the Marketplace. - -::: - -## Model - -A pre-trained AI model is a mandatory component for both types of orders. You can lease a model from the **Marketplace**, or you can add your uploaded model from **My Content**. - -To add a model to the order, click the blue **[+]** button next to it. - -Clicking the model's name opens its [**Offer**](/marketplace/marketplace/offer) window. It provides a detailed description and pricing. Your uploaded models do not have such window, and they do not have a price. - -To view the model's requirement slot, expand the **Requirements**. If an offer has multiple requirement slots, the **[+]** and **Requirements** buttons will open the **Pricing** tab within the model's **Offer** window. There, you can find the complete list of the model's requirement slots. - -If you add your uploaded model, its requirements are not specified. The system does not include such models in the automatic calculation of the compute configuration. - -:::warning - -Ensure your uploaded model fits into the total maximum compute configuration allowed for the testnet. Check the [Testnet Limitations](/marketplace/limitations). - -::: - -## Datasets - -A dataset is any data the model works with. For example, it can be a set of files for fine-tuning a model or a single file with a new layer for Deploy orders. - -Dataset is a mandatory component for Fine-tune orders, but optional for Deploy orders. - -:::note - -Datasets are not yet available in the current version of the Marketplace. - -::: - -## Engine - -The engine is required to deploy and fine-tune models. It also provides a web UI. - -At the moment, Marketplace supports two AI engines: - -- **Text Generation Web UI** for text-to-text models. -- **ComfyUI** for image- and video-related tasks. - -The Super Protocol team will add more popular open-source AI engines in the future. Currently, user-uploaded engines are not allowed as they may have built-in vulnerabilities. - -To add an engine to the order, click the blue **[+]** button next to it. If a yellow warning icon appears, it indicates that the selected engine is incompatible with a selected model. - -Clicking the engine's name opens its [**Offer**](/marketplace/marketplace/offer) window. - -Once you add an engine, you can open its configuration by pressing the **Settings** button. Only make changes if you are confident in what you are doing, as modifying these settings can cause the model to fail to deploy. For more information about the settings, refer to the documentation for [Text Generation Web UI](https://github.com/oobabooga/text-generation-webui/wiki) and [ComfyUI](https://docs.comfy.org/). - - -
-
- -For orders using tunnels, the engine settings will include the **Tunnels** tab with **Domain Settings**: - -- **Temporary Domain** uses pre-configured settings to create a domain on `superprotocol.io` with a randomly generated name, for example, `mund-avys-kefs.superprotocol.io`. It is the recommended option that does not require additional setup. -- **Manual Configuration** is not available right now. It will allow advanced users to host a model on a custom domain. This feature is not yet available in the current version of the Marketplace. - -## Compute - -The term _compute_ refers to a confidential computing machine that processes the order. - -The system automatically calculates a compute configuration that meets or exceeds the combined requirements of the models, datasets, and engine added to the order. To add a machine to the order, click the blue **[+]** button next to it. - -**In Queue** shows the number of orders waiting for an empty slot on this machine. If it is not zero, your order may take longer to process. Consider choosing another compute offer. - -Clicking the machine's name opens its [**Offer**](/marketplace/marketplace/offer) window. - -Screenshot showing the queue status indicator for compute offers -
- -Read about [requirements and configurations](/fundamentals/slots). - -## Checkout - -The panel at the bottom of the screen displays the total prices of the offers added to the order. - -**Fixed** is the total for all fixed-price offers. You will pay this sum immediately after placing the order. - -**Per Hour** is the total for all hourly-priced offers. This sum will be gradually deducted from the order deposit for each hour the order is running. - -**Lease Time** is the duration in hours for which you plan to run the order. Increasing the lease time raises the initial deposit amount. For Fine-tune orders, ensure the lease time is sufficient to complete the computation. For Deploy orders, this is the duration for which the model will remain running and available. - -Note that providers may set the minimum and maximum allowed lease time for their offers to limit the usage. The lease time you enter must be within these limits. - -**Pay now** is the initial order deposit you must pay at checkout. It is calculated using the formula: **Fixed** + (**Per Hour** * **Lease Time**). You can increase the deposit now by increasing the **Lease Time** or after checkout while the order is processing. - -The **Checkout** button opens the [**Confirm Transactions**](/marketplace/orders/order-builder/checkout) window that informs you about the creation of transactions on the blockchain. \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 40924fc1..cad9d710 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4852,15 +4852,10 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001538, caniuse-lite@^1.0.30001565, caniuse-lite@^1.0.30001646, caniuse-lite@^1.0.30001669: - version "1.0.30001680" - resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001680.tgz" - integrity sha512-rPQy70G6AGUMnbwS1z6Xg+RkHYPAi18ihs47GH0jcxIG7wArmPgY3XbS2sRdBbxJljp3thdT8BIqv9ccCypiPA== - -caniuse-lite@^1.0.30001688: - version "1.0.30001698" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001698.tgz#3e86d4bad6f87f493197fb2483a211fe8841abd3" - integrity sha512-xJ3km2oiG/MbNU8G6zIq6XRZ6HtAOVXsbOrP/blGazi52kc5Yy7b6sDA5O+FbROzRrV7BSTllLHuNvmawYUJjw== +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001538, caniuse-lite@^1.0.30001565, caniuse-lite@^1.0.30001646, caniuse-lite@^1.0.30001669, caniuse-lite@^1.0.30001688: + version "1.0.30001712" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001712.tgz" + integrity sha512-MBqPpGYYdQ7/hfKiet9SCI+nmN5/hp4ZzveOJubl5DTAMa5oggjAuoi0Z4onBpKPFI2ePGnQuQIzF3VxDjDJig== ccount@^1.0.3: version "1.1.0" @@ -10110,18 +10105,7 @@ react-helmet-async@*: react-fast-compare "^3.2.2" shallowequal "^1.1.0" -react-helmet-async@^1.3.0: - version "1.3.0" - resolved "https://registry.yarnpkg.com/react-helmet-async/-/react-helmet-async-1.3.0.tgz#7bd5bf8c5c69ea9f02f6083f14ce33ef545c222e" - integrity sha512-9jZ57/dAn9t3q6hneQS0wukqC2ENOBgMNVEhb/ZG9ZSxUetzVIw4iAmEU38IaVg3QGYauQPhSeUTuIUtFglWpg== - dependencies: - "@babel/runtime" "^7.12.5" - invariant "^2.2.4" - prop-types "^15.7.2" - react-fast-compare "^3.2.0" - shallowequal "^1.1.0" - -"react-helmet-async@npm:@slorber/react-helmet-async@*", "react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": +react-helmet-async@^1.3.0, "react-helmet-async@npm:@slorber/react-helmet-async@*", "react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": version "1.3.0" resolved "https://registry.yarnpkg.com/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz#11fbc6094605cf60aa04a28c17e0aab894b4ecff" integrity sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A==