.default})
+The term _order_ always implies the usage of a compute offer. Every additional offer added to the order creates a separate _suborder_ with the respective provider. If you add your uploaded solutions and data, they create no suborders.
-## Create orders
+Every order and suborder has a unique identification number—_order ID_. It is incremental and continuous for both orders and suborders.
-There are two ways to create orders:
+.default})
+-- The [Marketplace GUI](/marketplace) provides a more user-friendly experience, but you will be limited to the data and solution offers available on the Marketplace. -- CLI offers additional functionality (has not yet been fully implemented). +## Order composition -Orders are accessible on the blockchain just like everything else. So, while the content inside a Trusted Execution Environment is confidential, and the order results are encrypted, the general information about any order is available to anyone. +Most orders consist of four building blocks: -The content of the order, including the order result, is encrypted. Only the customer knows the private key necessary to decrypt it. The order result is kept by the storage suborder for as long as the customer keeps paying for it. +- **Solution**: Applications, engines, scripts, base images, and other programs. +- **Data**: Any data required by solutions. AI models fall into this category. +- **Compute**: Confidential computing resources required to execute solutions. +- **Storage**: Decentralized storage used to keep order results after execution. -Every order and suborder has a unique identification number—_order ID_. It is incremental and continuous for both orders and suborders. +Solutions and data may be either leased from the Marketplace or uploaded by users. -## Combinations +Compute and storage can currently only be provided by Super Protocol. -Most orders consist of four building blocks: +## Order creation -- **Solutions**: applications and base images -- **Data**: data required by solutions -- **Storage**: remote storage to keep solutions and data before the execution inside a Trusted Execution Environment as well as order results -- **Compute**: compute resources and a Trusted Execution Environment to execute together solutions and data. +There are two ways to place an order: -Solutions and data may be either provided by offers or deployed by users. Offers are available for monetization on the Marketplace. But users can also upload solutions and data they have locally and add them to orders instead of using offers. +- The [Marketplace web app](https://marketplace.superprotocol.com/) is user-friendly, but limited to deploying AI models using the engines available on the Marketplace. +- The [command-line interface (CLI)](/cli) allows the launch of any applications and provides additional functionality. -Storage and compute can only be provided by offers. Currently, only Super Protocol provides storage and compute resources. +Orders exist on the blockchain and are visible to anyone. So, while the solutions and data inside a Trusted Execution Environment (TEE) remain confidential, the general information about any order is available using the CLI. + +The order result is kept by the storage suborder for as long as the customer keeps paying for it. Only the customer who placed the order knows the private key necessary to decrypt the result. ## Usage scenarios Depending on the solution, there are two typical usage scenarios: -- One-off order performs a specific computation and produce a result. For example, using an AI model to run an inference on a batch of data or fine-tuning an AI model. -- Long-term order runs an app, such as an LLM with a web-interface deployed using [confidential tunnels](/fundamentals/tunnels). It keeps running as long as the order has money on the balance. - -## Lease, deposit, and balance +- One-off orders perform a specific computation and produce a result, such as an order to fine-tune an AI model. +- Long-term orders keep running as long as the order has money in the balance. For example, an order to deploy an AI model using an engine with a web interface accessible through a confidential tunnel. -_Lease time_ is the duration for which a customer rents the services of an offer. Solution and data are suborders, so their lease time is tied to the compute lease time. +_Lease time_ is the duration for which a customer rents the services of an offer. Solutions, data, and storage are suborders, so their lease time is tied to the compute lease time. -_Deposit_ is the initial payment for the order. Lease time is necessary to calculate the deposit during the order creation. +_Deposit_ is the initial payment for the order. It is calculated during the order creation depending on the selected offers and the desired lease time. Order _balance_ is a dedicated amount of funds to pay the providers. The deposit determines the initial balance. Long-term orders keep working as long as there is money on the balance to pay the provider. If the customer wants to extend the lease time, they can _replenish the balance_—add more funds. The customer gets all unspent tokens back automatically when the order is completed or canceled. -When the balance is close to zero, the order gets the "awaiting payment" flag. It warns the customer that the lease time will end soon. Marketplace GUI highlights such orders with a bright orange color. +When the balance is close to zero, the order gets the "awaiting payment" flag. It warns the customer that the lease time will end soon. The Marketplace web app highlights such orders with a bright orange color. ## Cost and pricing -Super Protocol uses a _Pay-As-You-Go_ model. Customers pay for services as they use them, rather than paying for a set period upfront. +Super Protocol uses a _Pay-as-you-go_ model. Customers pay for services as they use them, rather than paying for a set period upfront. Every offer has a cost set by its provider. The price can be either fixed or per hour depending on the offer. -| **Offer Type** | **Pricing Conditions** |**Description** | +| **Offer Type** | **Pricing** | **Description** | |:-|:-|:-| -| Solution | Fixed or per hour | Solution may require one-time payment or every hour of usage. | -| Data | Fixed or per hour | Data may require one-time payment or every hour of usage. | -| Compute | Per hour | The main order works until it is completed or the balance runs out. | -| Storage | Per hour | The storage suborder launches when the main order is completed to keep the order result until the balance runs out. | +| Solution | Fixed or per hour | Solution may require one-time payment or an hourly payment. | +| Data | Fixed or per hour | Data may require one-time payment or an hourly payment. | +| Compute | Per hour | The main order works until it is completed or the balance runs out. | +| Storage | Per hour | The storage suborder launches when the main order is completed to keep the order result until the balance runs out. | ## Order status -You can check the status of any order in the Marketplace GUI on the **All Orders** page. In the Marketplace CLI, use the `orders get` command. - -### Compute order statuses - -A compute order—the main order—begins as **Suspended**. This status means that the order waits for the creation of solution and data suborders. +You can check the status of your order in the Marketplace web app on the **All Orders** screen. In the CLI, use the [`orders get`](/cli/commands/orders/get) command. -When the suborders are created, the compute order gets the **Blocked** status. At this stage, the solution and data providers generate keys and authorize the compute provider to access the content. +### Compute order -Once this is done, the compute order gets the **New** status and waits in the queue for the compute offer to become available. +Statuses: -When the machine is available, the compute order gets the status **Processing**, which is the main status for execution inside a Trusted Execution Environment. When the order is completed, it receives the **Done** status. +- **Suspended**: The order is waiting for the creation of the solution and data suborders. +- **Blocked**: The order is waiting for the authorization from the solution and data providers to access the content. +- **New**: The order is waiting for the response from the compute provider. +- **In Queue**: The order is waiting in the queue for the compute to become available. This status appears only if the compute is overloaded with orders. +- **Processing**: The compute is executing the order inside a TEE. +- **Done**: The order is completed. -Note that the **Processing** and **Done** statuses may have different meanings depending on the usage scenario. For one-time orders such as Python models, **Processing** means that the machine is working with the solution and data. When this processing is over, the main order becomes **Done**. +Note that the **Processing** and **Done** statuses may have different meanings depending on the usage scenario. For one-time orders, such as executing a Python script, **Processing** means that the machine is working with the solution and data. When this is over, the main order becomes **Done**. -For long-term orders such as tunnel and storage orders, **Processing** means that the order is up and running normally, accessible to users, providing services, etc. And when the order is **Done**, the order has ended and is no longer working. +For long-term orders, such as AI model deployment orders, **Processing** means that the order is up and running normally, and its service is accessible to users. When the order is **Done**, the order ends, and the service is no longer available. -### Solution and data +### Solution and data suborders -A solution or data suborder starts as **New**. It means that the suborder was created on the blockchain. +Statuses: -The next status is **Processing**. At this stage, the solution and data providers generate keys and authorize the compute provider to access the content. The suborder becomes **Done**, and the providers withdraw their earnings from the order. Typically, all these steps take less than a minute. +- **New**: The suborder was created on the blockchain. +- **Processing**: The offer provider authorizes the compute to access the offer content—the solution or data. +- **Done**: The content is available to the compute, and the offer provider withdraws their earnings from the order. -The above applies to the Marketplace offers that have providers. If you deploy your solution or data, they are downloaded into the Trusted Execution Environment before the order starts. +Typically, these steps take less than a minute. -### Storage +If you launch your solution or data, they create no suborders. The compute downloads your solution and data into the TEE before processing the order. -Storage suborder keeps the order result after the main order is completed. The Trusted Execution Environment does not store anything and is destroyed after the order ends. +### Storage suborder -A storage suborder also starts as **New**. When the order result is ready, the storage suborder receives the status **Processing**. It means, the suborder has the order result, and the customer can download it. +Storage keeps the encrypted order result after the order is completed. The TEE does not store anything and is destroyed after the main order is done. Typically the storage suborder is created when the main order is almost completed. -When the lease expires the suborder becomes **Done**. It means the order result is no longer available. +Statuses: -Typically the storage suborder is created when the main order is almost completed to keep the result available for the customer. However, sometimes there is no order result to store. In this case, the storage suborder is not created. +- **New**: The suborder was created, but the order result is not ready yet. +- **Processing**: The storage now has the order result, and the customer can download it. +- **Done**: The lease expired, and the order result is no longer available. -Users can create independent storage orders to keep files, for example, for [community offers](/fundamentals/offers#community-offers). This functionality is only available in CLI using the `files upload` command. Note that such orders do not appear in **All orders** in the Marketplace GUI. +Users can create independent storage orders to keep files. This functionality is only available via the CLI using the [`files upload`](/cli/commands/files/upload) command. Note that such orders do not appear in the Marketplace web app. -### Cancelations +### Order cancelation -Any order or suborder may be canceled. If the customer cancels the main order, all its suborders are canceled as well. Similarly, if the customer cancels a solution or data suborder, the main orders and all its suborders are canceled too. Storage suborders may be canceled without affecting the main order because they start when the main order is **Done**. +Any order or suborder may be canceled. If the customer cancels the main order, all its suborders are canceled as well. Similarly, if the customer cancels a solution or data suborder, the main orders and all its suborders are canceled too. Storage suborders may be canceled without affecting the main order because they start when the main order is already done. In any case, all tokens left of the balance are returned to the customer. @@ -116,26 +122,26 @@ Statuses: - **Canceling**: The order is being canceled. - **Canceled**: The order is canceled. -### Stuck orders - -If you are using a community offer in your order and the offer fails to respond, your order will not proceed. When you see your order stuck with the **New** status for more than 15 minutes, check the community offer you used. If it is in the **Inactive** category, this offer is nonfunctional. Cancel your order to return the deposit. - ## Events -
.default})
+To check the information on what is happening with the order, check the [**Events** tab](/marketplace/all-orders/order#events-tab) on the **Order** screen in the Marketplace web app.
+
+.default})
+
+ +The tab shows, among other things: -Check the **Events** tab on the order page in the Marketplace GUI to get more information on what is happening with the order. The tab shows, among other things: -- List of the main blockchain events -- Correlation between the events and the order and suborder statuses -- Absolute transaction values -- Links to the transaction details on a block explorer +- The list of the main blockchain events. +- Correlation between the events and the order and suborder statuses. +- Absolute transaction values. +- Links to the transaction details on a block explorer. -The main blockchain events are: +The main blockchain events: -- **OrderCreated**: the order or sub-order is created on the blockchain. -- **OrderStarted**: the compute order has started. -- **OrderStatusUpdated**: the order or sub-order status has changed without any new events. -- **OrderEncryptedResultUpdated**: the resource path to the order result was written to the blockchain. -- **OrderChangeWithdrawn**: the remaining token balance was returned to the customer. -- **OrderProfitWithdrawn**: the provider withdrew the offer payment from the order balance. +- **OrderCreated**: The order or suborder is created on the blockchain. +- **OrderStarted**: The compute order has started. +- **OrderStatusUpdated**: The order or suborder status has changed without any new events. +- **OrderEncryptedResultUpdated**: The resource path to the order result was written to the blockchain. +- **OrderChangeWithdrawn**: The remaining token balance was returned to the customer. +- **OrderProfitWithdrawn**: The provider withdrew the offer payment from the order balance. diff --git a/docs/fundamentals/slots.md b/docs/fundamentals/slots.md index 61bdaf7f..d97fc1b4 100644 --- a/docs/fundamentals/slots.md +++ b/docs/fundamentals/slots.md @@ -5,11 +5,13 @@ slug: "/slots" sidebar_position: 4 --- -_Requirements_ describe the parameters that a solution, data, or storage offer needs to run. _Configurations_ provide flexibility in selecting computing resources and internet access for offer deployment. The compute offer configuration added to an order must meet all the value offer requirements in this order. +_Requirements_ describe the parameters that a solution, data, or storage offer needs to run. + +_Configurations_ provide flexibility in selecting computing resources and internet access for offer deployment. The compute offer configuration added to an order must meet all the value offer requirements in this order. ## Requirements -Requirements specify how much computing resources a [value offer](/fundamentals/offers#types-of-offers) needs to run. A _requirement slot_ is a specific set of requirements that may include the following: +Requirements specify how much computing resources a value offer needs to run. A _requirement slot_ is a specific set of requirements that may include the following: - Number of CPU cores - RAM diff --git a/docs/fundamentals/tunnels.md b/docs/fundamentals/tunnels.md index ea5dd504..253dc16a 100644 --- a/docs/fundamentals/tunnels.md +++ b/docs/fundamentals/tunnels.md @@ -7,7 +7,7 @@ sidebar_position: 5 _Tunneling_ is a communication method that wraps data within a different data format to transmit securely and efficiently across a network. This creates a virtual communication channel—a _tunnel_—within the network. Data passes through securely and appears to be traveling over a direct connection. -Super Protocol has implemented tunnels to provide decentralized confidential computing as a web service. In Super Protocol, a tunnel consists of the Tunnel Server and Tunnel Client solutions with a confidential connection between them. Tunnel servers have an external public IP. They are accessible from the internet via HTTPS through a browser or another service through API. Tunnel clients run web servers and hide behind tunnel servers from malicious attacks. Both tunnel server and client run inside a Trusted Execution Environment on their respective machines. This ensures the confidentiality of the content and execution. +Super Protocol has implemented tunnels to provide decentralized confidential computing as a web service. In Super Protocol, a tunnel consists of the Tunnel Server and Tunnel Client solutions with a confidential connection between them. Tunnel servers have an external public IP. They are accessible from the internet via HTTPS through a browser or another service through API. Tunnel clients run web servers and hide behind tunnel servers from malicious attacks. Both tunnel server and client run inside a Trusted Execution Environment on their respective machines. This ensures the confidentiality of the content and execution. Super Protocol supports the deployment of multiple instances of clients and servers. Distributing tunnels over different cloud service providers increases decentralization and fault tolerance. diff --git a/docs/marketplace/account/index.md b/docs/marketplace/account/index.md index 1256d063..f0b90d1e 100644 --- a/docs/marketplace/account/index.md +++ b/docs/marketplace/account/index.md @@ -19,7 +19,7 @@ _Web3 User account_ is the recommended account type in Super Protocol. It provid - 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 with Marketplace offers or the user's own uploaded content. +- 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. - Creation and monetization of model and dataset offers on the Marketplace. - Ability to request additional SPPI tokens. diff --git a/docs/marketplace/account/web3.md b/docs/marketplace/account/web3.md index 536a0131..58b70e65 100644 --- a/docs/marketplace/account/web3.md +++ b/docs/marketplace/account/web3.md @@ -15,7 +15,7 @@ This window allows you to manage your [Web3 User account](/marketplace/account#w **Login**: the Web3 login method and the EVM wallet address you are using. Currently, Super Protocol only supports MetaMask as a Web3 login method. -**Get SPPI** and **Get BNB** buttons allow you to get tokens necessary to place orders: +**Get SPPI** and **Get BNB** buttons allow you to get tokens necessary to place orders: - SPPI tokens are required to pay and receive payments in Super Protocol. - BNB tokens are required to pay for opBNB blockchain transactions. diff --git a/docs/marketplace/all-orders/index.md b/docs/marketplace/all-orders/index.md index 6fe38225..753c406f 100644 --- a/docs/marketplace/all-orders/index.md +++ b/docs/marketplace/all-orders/index.md @@ -5,7 +5,7 @@ slug: "/all-orders" sidebar_position: 6 --- -This screens displays the full list of the orders you placed on Super Protocol. +This screens displays the full list of the orders you placed on Super Protocol.
.default})
diff --git a/docs/marketplace/all-orders/order.md b/docs/marketplace/all-orders/order.md index b88de02f..2bc346ea 100644 --- a/docs/marketplace/all-orders/order.md +++ b/docs/marketplace/all-orders/order.md @@ -5,7 +5,7 @@ slug: "/all-orders/order" sidebar_position: 1 --- -This screen provides detailed information about a particular order. Read about [Orders](/fundamentals/orders). +This screen provides detailed information about a particular order. Read about [Orders](/fundamentals/orders).
.default})
@@ -20,7 +20,7 @@ The contents of an order are encrypted and accessible only to the user who place - **Suspended**. The order is awaiting the creation of suborders. - **Blocked**. A suborder temporarily blocks the order to generate access keys and authorize the confidential computing device to access the suborder's content. - **In Queue**. The order is awaiting in the queue for the computing device to become available. -- **Processing**. The machine is executing the order inside a Trusted Execution Environment. +- **Processing**. The machine is executing the order inside a Trusted Execution Environment. Statuses specific for Deploy orders: @@ -35,7 +35,7 @@ Additional possible statuses: Read about [statuses](/fundamentals/orders#order-status). -**Lease Remaining** indicates the remaining time until the order is completed and gets the Done status. It is calculated by dividing the remaining order balance by the total cost of all the offers priced per hour. For Deploy orders with the Deployed status, it is the duration the model will remain operational. +**Lease Remaining** indicates the remaining time until the order is completed and gets the Done status. It is calculated by dividing the remaining order balance by the total cost of all the offers priced per hour. For Deploy orders with the Deployed status, it is the duration the model will remain operational. ## Financials @@ -134,19 +134,19 @@ The **Events** tab contains information on what is happening with the order.
-- **Date**: the date and time of the event. -- **Order ID**: the identification number of the order or suborder to which the event is related. +- **Date**: The date and time of the event. +- **Order ID**: The identification number of the order or suborder to which the event is related. - **Order Type**: either **Order** or **Suborder**. - **Type**: **Compute** for the main order; **Solution**, **Data**, or **Storage** for suborders. -- **Provider**: the name of the provider. -- **Name**: the name of the offer. -- **Status**: status of the order or suborder when the event occurred. -- **Event**: code of what happened. The full list of the events: - + **OrderCreated**: the order or suborder is created on the blockchain. - + **OrderStarted**: the compute order has started. - + **OrderStatusUpdated**: the order or suborder status has changed without any new events. - + **OrderEncryptedResultUpdated**: the resource path to the order result was written to the blockchain. - + **OrderChangeWithdrawn**: the remaining token balance was returned to the customer. - + **OrderProfitWithdrawn**: the provider withdrew the offer payment from the order balance. -- **Value**: transaction value in SPPI tokens, if applicable. -- **Txn Hash**: transaction hash. Clicking it opens the transaction in the [OKLink block explorer](https://www.oklink.com/). \ No newline at end of file +- **Provider**: The name of the provider. +- **Name**: The name of the offer. +- **Status**: The status of the order or suborder when the event occurred. +- **Event**: The code of what happened. The main blockchain events: + + **OrderCreated**: The order or suborder is created on the blockchain. + + **OrderStarted**: The compute order has started. + + **OrderStatusUpdated**: The order or suborder status has changed without any new events. + + **OrderEncryptedResultUpdated**: The resource path to the order result was written to the blockchain. + + **OrderChangeWithdrawn**: The remaining token balance was returned to the customer. + + **OrderProfitWithdrawn**: The provider withdrew the offer payment from the order balance. +- **Value**: The transaction value in SPPI tokens, if applicable. +- **Txn Hash**: The transaction hash. Clicking it opens the transaction in the [OKLink block explorer](https://www.oklink.com/). \ No newline at end of file diff --git a/docs/marketplace/confidentiality.md b/docs/marketplace/confidentiality.md index 6d218c6f..75b7036e 100644 --- a/docs/marketplace/confidentiality.md +++ b/docs/marketplace/confidentiality.md @@ -5,19 +5,19 @@ 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). +*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).
.default})
-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). +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. +- 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.
.default})
diff --git a/docs/marketplace/guides/deploy-model.md b/docs/marketplace/guides/deploy-model.md index deba5c9e..0ab8bdc5 100644 --- a/docs/marketplace/guides/deploy-model.md +++ b/docs/marketplace/guides/deploy-model.md @@ -5,23 +5,23 @@ slug: "/guides/deploy-model" sidebar_position: 4 --- -This guide provides step-by-step instructions on how to upload and deploy an AI model. +This guide provides step-by-step instructions for uploading and deploying an AI model. :::note -Uploading models is currently available to Web2 users only. +Uploading models and creating offers are currently available to Web2 users only. ::: -## 1. Create an offer +## 1. Upload 1.1. In the **My Offers** screen, click the **New Offer** button. -
.default})
+.default})
-1.2. Complete all the fields in the appearing window. +1.2. Complete all fields in the appearing window.
.default})
@@ -40,33 +40,29 @@ Due to [Testnet limitations](/marketplace/limitations), the total size of model ::: -1.3. Click the **Create Offer** button. Do not close the window until the upload is complete. +1.3. Click the **Create Offer** button. Do not close the window until the upload is complete. This may take a few minutes. -## 2. Open the Offer Builder +1.4. When the upload is complete, close the New Offer window or click **Go to Offer** to open the offer in the [Offer Builder](/marketplace/my-offers/offer-builder). -The created offer is unpublished. You need to configure it in the Offer Builder before publishing to the Marketplace. +
.default})
+-To open the offer in the Offer Builder, click **Go to Offer** in the **New Offer** window. +## 2. Deploy -
.default})
--
+2.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. -Or click the **Edit** button next to your offer in the **My Offers** screen. +2.2. In the Order Builder, review and modify the order if necessary. Click **Pay Now** to place the order. -
.default})
+.default})
+-## 3. Check the model files - -In the **Files** tab, ensure the model format is recognized correctly. +2.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. -
.default})
+.default})
-If you need to upload more files related to this model, click the **Add Files** button. - -## 4. Deploy the model +2.4. When your order is ready, you will see the Deployed status and an Access Link to your model's interface. -Click the **Deploy** button in the bottom-right corner of the screen. This will build an order with your model for a quick deployment. \ No newline at end of file +
.default})
\ No newline at end of file
diff --git a/docs/marketplace/guides/log-in.md b/docs/marketplace/guides/log-in.md
index f61f8cd0..1cf6e00f 100644
--- a/docs/marketplace/guides/log-in.md
+++ b/docs/marketplace/guides/log-in.md
@@ -109,7 +109,7 @@ Super Protocol users need two types of tokens:
- SPPI tokens to pay and receive payments in Super Protocol.
- BNB tokens to pay for opBNB blockchain transactions.
-Both types are necessary to place orders. During the testnet, you can request free tokens in the **Account** setting.
+Both types are necessary to place orders. During the testnet, you can request free tokens in the **Account** setting.
.default})
diff --git a/docs/marketplace/guides/publish-offer.md b/docs/marketplace/guides/publish-offer.md index c3728142..686494ec 100644 --- a/docs/marketplace/guides/publish-offer.md +++ b/docs/marketplace/guides/publish-offer.md @@ -12,7 +12,7 @@ This guide provides step-by-step instructions on how to register a provider and :::note -Creating offers is currently available to Web2 users only. +Uploading models and creating offers are currently available to Web2 users only. ::: @@ -20,20 +20,20 @@ Creating offers is currently available to Web2 users only. 1.1. In the [Marketplace web app](https://marketplace.superprotocol.com/), open your account settings. -
.default})
+.default})
1.2. Scroll down, type in the desired **Provider Name**, and click **Create Provider**. -
.default})
+.default})
## 2. Create an offer 2.1. In the **My Offers** screen, click the **New Offer** button. -
+
@@ -56,7 +56,7 @@ Due to [Testnet limitations](/marketplace/limitations), the total size of the mo ::: -2.3. Click the **Create Offer** button. Do not close the window until the upload is complete. +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 @@ -64,7 +64,7 @@ The created offer is unpublished. You need to configure it in the Offer Builder To open the offer in the Offer Builder, click **Go to Offer** in the **New Offer** window. -
+
@@ -77,7 +77,7 @@ Alternatively, click the **Edit** button next to the offer in the **My Offers** In the **Files** tab, ensure the model formats are recognized correctly. -
+.default})
@@ -120,7 +120,7 @@ If the offer supports both GPU-only and CPU-only engines, create at least one sl Complete the following fieds: - **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. + + **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. - **GPU RAM**: Set the required video RAM in gigabytes (GB). diff --git a/docs/marketplace/guides/troubleshooting.md b/docs/marketplace/guides/troubleshooting.md index a3dff77c..fb64b20d 100644 --- a/docs/marketplace/guides/troubleshooting.md +++ b/docs/marketplace/guides/troubleshooting.md @@ -25,7 +25,7 @@ Possible solutions: ## Order status: Error -Issue: the order processing stops due to the **Error** status. +Issue: the order processing stops due to the **Error** status.
.default})
diff --git a/docs/marketplace/images/publish-offer-create-provider.png b/docs/marketplace/images/account-create-provider.png similarity index 100% rename from docs/marketplace/images/publish-offer-create-provider.png rename to docs/marketplace/images/account-create-provider.png diff --git a/docs/marketplace/images/deploy-models.png b/docs/marketplace/images/deploy-models.png deleted file mode 100644 index 70113ed5..00000000 Binary files a/docs/marketplace/images/deploy-models.png and /dev/null differ diff --git a/docs/marketplace/images/deploy-my-content.png b/docs/marketplace/images/deploy-my-content.png deleted file mode 100644 index 20e0cd0b..00000000 Binary files a/docs/marketplace/images/deploy-my-content.png and /dev/null differ diff --git a/docs/marketplace/images/publish-offer-account.png b/docs/marketplace/images/my-offers-account.png similarity index 100% rename from docs/marketplace/images/publish-offer-account.png rename to docs/marketplace/images/my-offers-account.png diff --git a/docs/marketplace/images/publish-offer-new-offer.png b/docs/marketplace/images/my-offers-new-offer.png similarity index 100% rename from docs/marketplace/images/publish-offer-new-offer.png rename to docs/marketplace/images/my-offers-new-offer.png diff --git a/docs/marketplace/images/publish-offer-new-offer-go-to-offer.png b/docs/marketplace/images/new-offer-go-to-offer.png similarity index 100% rename from docs/marketplace/images/publish-offer-new-offer-go-to-offer.png rename to docs/marketplace/images/new-offer-go-to-offer.png diff --git a/docs/marketplace/images/publish-offer-files.png b/docs/marketplace/images/offer-builder-format.png similarity index 100% rename from docs/marketplace/images/publish-offer-files.png rename to docs/marketplace/images/offer-builder-format.png diff --git a/docs/marketplace/images/order-builder-pay-now.png b/docs/marketplace/images/order-builder-pay-now.png new file mode 100644 index 00000000..4e9d39f7 Binary files /dev/null and b/docs/marketplace/images/order-builder-pay-now.png differ diff --git a/docs/marketplace/images/order-deployed-online.png b/docs/marketplace/images/order-deployed-online.png new file mode 100644 index 00000000..095ae5af Binary files /dev/null and b/docs/marketplace/images/order-deployed-online.png differ diff --git a/docs/marketplace/images/order-processing.png b/docs/marketplace/images/order-processing.png new file mode 100644 index 00000000..eb591876 Binary files /dev/null and b/docs/marketplace/images/order-processing.png differ diff --git a/docs/marketplace/index.md b/docs/marketplace/index.md index 792c6067..7be956f5 100644 --- a/docs/marketplace/index.md +++ b/docs/marketplace/index.md @@ -19,7 +19,7 @@ Super Protocol launched the first public release of Marketplace 2.0 on November Upcoming features in the future development phases: -- Publishing offers in the Marketplace from uploaded files. Currently, publishing is limited to selected researchers, testers, and developers. +- 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. diff --git a/docs/marketplace/limitations.md b/docs/marketplace/limitations.md index be4470af..abc02763 100644 --- a/docs/marketplace/limitations.md +++ b/docs/marketplace/limitations.md @@ -13,7 +13,7 @@ During the testnet, you can deploy models using either Intel TDX CPUs or NVIDIA Super Protocol supports two types of machines: -- **TDX+H100 (CPU and GPU)** can run orders on GPU or CPU, depending on the selected engine type. +- **TDX+H100 (CPU and GPU)** can run orders on GPU or CPU, depending on the selected engine type. - **TDX (CPU only)** can only run orders on CPU. Note that CPUs are much slower. Super Protocol constantly adds more TDX+H100 machines and will soon begin onboarding machines from third-party providers. diff --git a/docs/marketplace/models/index.md b/docs/marketplace/models/index.md index cfbf8a04..b5d662ed 100644 --- a/docs/marketplace/models/index.md +++ b/docs/marketplace/models/index.md @@ -5,11 +5,11 @@ 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. +This screen lists AI models that users offer on the Marketplace. You can lease the content listed here by adding it to your orders. :::note -Datasets are not yet available in the current version of the Marketplace. +Datasets will be available in future versions of the Marketplace. ::: diff --git a/docs/marketplace/models/offer.md b/docs/marketplace/models/offer.md index 9f2eb342..2dd06268 100644 --- a/docs/marketplace/models/offer.md +++ b/docs/marketplace/models/offer.md @@ -12,7 +12,7 @@ This window provides information about a model available for lease on the Market ## Metadata -On the right-hand side of the window, you can find metadata about the offer: +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 all offers. - **Offer Type**: The type of the offer: @@ -50,7 +50,7 @@ Slots may be divided into two categories: Super Protocol supports two pricing types: -- **Fixed**: a one-time payment for each order, regardless of the lease duration. +- **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: diff --git a/docs/marketplace/my-offers/index.md b/docs/marketplace/my-offers/index.md index eb18b79c..031ef4fc 100644 --- a/docs/marketplace/my-offers/index.md +++ b/docs/marketplace/my-offers/index.md @@ -5,7 +5,7 @@ slug: "/my-offers" sidebar_position: 5 --- -This screen allows you to browse your offers and deploy uploaded models. +This screen allows you to browse your offers and deploy uploaded models.
.default})
@@ -17,4 +17,4 @@ The table in the center of the screen lists all your offers—both published and The **Edit** button opens the [Offer Builder](/marketplace/my-offers/offer-builder), where you can configure and publish the offer. -The **Deploy** button adds the offer to an order and opens the [Order Builder](/marketplace/order-builder) for quick deployment. \ No newline at end of file +The **Deploy** button adds the offer to an order and opens the [Order Builder](/marketplace/order-builder) for quick deployment. \ No newline at end of file diff --git a/docs/marketplace/my-offers/new-offer.md b/docs/marketplace/my-offers/new-offer.md index c834d011..0912b525 100644 --- a/docs/marketplace/my-offers/new-offer.md +++ b/docs/marketplace/my-offers/new-offer.md @@ -5,7 +5,7 @@ slug: "/my-offers/new-offer" sidebar_position: 1 --- -This window allows you to upload a model and create an offer. After uploading, you can deploy the model. Additionally, you can configure and publish the offer on the Marketplace to lease the uploaded model to other users. +This window allows you to upload a model and create an offer. After uploading, you can deploy the model. Additionally, you can configure and publish the offer on the Marketplace to lease the uploaded model to other users.
diff --git a/docs/marketplace/my-offers/offer-builder.md b/docs/marketplace/my-offers/offer-builder.md index f79e4264..0b6cb11c 100644 --- a/docs/marketplace/my-offers/offer-builder.md +++ b/docs/marketplace/my-offers/offer-builder.md @@ -5,7 +5,7 @@ slug: "/my-offers/offer-builder" sidebar_position: 2 --- -_Offer Builder_ is a tool for uploading models and creating, editing, and publishing offers. +_Offer Builder_ is a tool for uploading models and creating, editing, and publishing offers. To deploy your AI model, you must upload it and create an offer. Newly created offers are unpublished, meaning only you can view them and add them to orders for deployment. @@ -71,7 +71,7 @@ To support both CPU-only and GPU-only engines, create separate requirement slots The **Add Slot** button opens an editable template for a slot that allows you to set the offer requirements: - **Price**: The price in SPPI tokens for leasing the model and the pricing type: - + **Fixed**: A one-time payment for each order, regardless of the lease duration. + + **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. - **CPU vCores**: Number of virtual CPU cores; can be fractional. Set to `0` to create a slot for GPU-only engines. - **CPU RAM**: RAM in gigabytes (GB). Set to `0` to create a slot for GPU-only engines. diff --git a/docs/marketplace/order-builder/checkout.md b/docs/marketplace/order-builder/checkout.md index d20f4c31..5dc80db4 100644 --- a/docs/marketplace/order-builder/checkout.md +++ b/docs/marketplace/order-builder/checkout.md @@ -5,7 +5,7 @@ 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. +This window informs you about the creation of transactions on the blockchain, which is the final step in placing an order.
.default}){kind=spacer}
diff --git a/docs/marketplace/order-builder/compatibiity.md b/docs/marketplace/order-builder/compatibiity.md index 7017c404..963a360a 100644 --- a/docs/marketplace/order-builder/compatibiity.md +++ b/docs/marketplace/order-builder/compatibiity.md @@ -5,7 +5,7 @@ slug: "/order-builder/compatibility" sidebar_position: 1 --- -This window informs you about issues with your order. You must fix them before you will be able to check out. +This window informs you about issues with your order. You must fix them before you will be able to check out. ## Not compatible with the model @@ -16,7 +16,7 @@ This message appears when the selected model and a dataset do not belong to the ## 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: +This message appears when the selected engine does not support the model or dataset. An example of such a message:
.default})
@@ -39,7 +39,7 @@ This message appears if the lease time entered before checkout is either too sho
-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. +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 index 2a07fef9..0998edff 100644 --- a/docs/marketplace/order-builder/index.md +++ b/docs/marketplace/order-builder/index.md @@ -5,7 +5,7 @@ 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: +_Order Builder_ is a tool to configure orders to deploy AI models. Deployment orders consist of three main components: - **Model** - **Engine** @@ -16,7 +16,7 @@ _Order Builder_ is a tool to configure deployment orders for AI models. Deployme ## 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 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 blue **[+]** button next to the desired slot. diff --git a/src/theme/Layout/index.js b/src/theme/Layout/index.js index 8b578f61..b7488128 100644 --- a/src/theme/Layout/index.js +++ b/src/theme/Layout/index.js @@ -14,6 +14,24 @@ export default function Layout(props) {
digital certificates.
+ ᐧ Solution offers: Applications, engines, scripts, base images, and other programs.
+ ᐧ Data offers: Any data required by solutions. AI models fall into this category.
+ ᐧ Compute offers: Confidential computing resources required to execute solutions.
+ ᐧ Storage offers: Decentralized storage used to keep order results after execution. +
+ The term main order—or simply order—implies leasing a compute offer.
+ The term suborder implies leasing a model, engine, or storage offer. +