diff --git a/docs/cli/commands/files/delete.md b/docs/cli/commands/files/delete.md index c8f679dd..6040a43f 100644 --- a/docs/cli/commands/files/delete.md +++ b/docs/cli/commands/files/delete.md @@ -12,8 +12,8 @@ The resource JSON file is created as a result of the [`files upload`](/cli/comma ## Syntax ``` -./spctl files delete \ - [--config ] \ +./spctl files delete + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/files/download.md b/docs/cli/commands/files/download.md index 45bec22b..0c380c3f 100644 --- a/docs/cli/commands/files/download.md +++ b/docs/cli/commands/files/download.md @@ -12,8 +12,8 @@ The resource JSON file is created as a result of the [`files upload`](/cli/comma ## Syntax ``` -./spctl files download \ - [--config ] \ +./spctl files download + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/files/upload.md b/docs/cli/commands/files/upload.md index ba4fdc6c..b596a777 100644 --- a/docs/cli/commands/files/upload.md +++ b/docs/cli/commands/files/upload.md @@ -24,15 +24,15 @@ The output of the command is a resource JSON file with the information for a com ## Syntax ``` -./spctl files upload \ - [--filename ] \ - [--output ] \ - [--skip-encryption] \ - [--metadata ] \ - [--max-concurrent ] \ - [--storage ] \ - [--min-rent-minutes ] \ - [--config ] \ +./spctl files upload + [--filename ] + [--output ] + [--skip-encryption] + [--metadata ] + [--max-concurrent ] + [--storage ] + [--min-rent-minutes ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/index.md b/docs/cli/commands/index.md index 4af1326b..adc2a2c8 100644 --- a/docs/cli/commands/index.md +++ b/docs/cli/commands/index.md @@ -50,9 +50,8 @@ Command syntax may also contain the following special characters: - Curly brackets `{ }` indicate a required choice between two or more options or arguments. - A vertical bar `|` separates mutually exclusive options or arguments you must choose from. - An ellipsis `...` indicates you may use the preceding option or argument multiple times. -- A backslash `\` breaks a long command line for better readability. -Never include these special characters, except backslash `\`, in the final command. Do not include backslashes `\` if you type a command in a single line. +Never include these special characters in the final command. ### Example diff --git a/docs/cli/commands/offers/add-slot.md b/docs/cli/commands/offers/add-slot.md index 08c8d4b6..59316378 100644 --- a/docs/cli/commands/offers/add-slot.md +++ b/docs/cli/commands/offers/add-slot.md @@ -15,10 +15,10 @@ Refer to the [Providers and Offers] guide to create the initial offer requiremen ## Syntax ``` -./spctl offers add-slot \ - --offer \ - [--path ] \ - [--config ] \ +./spctl offers add-slot + --offer + [--path ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/delete-slot.md b/docs/cli/commands/offers/delete-slot.md index 3d053d95..8c67bcbe 100644 --- a/docs/cli/commands/offers/delete-slot.md +++ b/docs/cli/commands/offers/delete-slot.md @@ -15,10 +15,10 @@ Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all s ## Syntax ``` -./spctl offers delete-slot \ - --offer \ - --slot \ - [--config ] \ +./spctl offers delete-slot + --offer + --slot + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/disable.md b/docs/cli/commands/offers/disable.md index 760f8586..6e3101b4 100644 --- a/docs/cli/commands/offers/disable.md +++ b/docs/cli/commands/offers/disable.md @@ -13,8 +13,8 @@ Disables an existing enabled offer. ## Syntax ``` -./spctl offers disable \ - [--config ] \ +./spctl offers disable + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/download-content.md b/docs/cli/commands/offers/download-content.md index 4c797560..75798795 100644 --- a/docs/cli/commands/offers/download-content.md +++ b/docs/cli/commands/offers/download-content.md @@ -13,9 +13,9 @@ The command only works with offers that allow this operation. ## Syntax ``` -./spctl offers download-content \ - [--save-to ] \ - [--config ] \ +./spctl offers download-content + [--save-to ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/enable.md b/docs/cli/commands/offers/enable.md index a2c963d8..d8dbf557 100644 --- a/docs/cli/commands/offers/enable.md +++ b/docs/cli/commands/offers/enable.md @@ -13,8 +13,8 @@ Enables an existing disabled offer. ## Syntax ``` -./spctl offers enable \ - [--config ] \ +./spctl offers enable + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/get-info.md b/docs/cli/commands/offers/get-info.md index fc4a5643..688820ec 100644 --- a/docs/cli/commands/offers/get-info.md +++ b/docs/cli/commands/offers/get-info.md @@ -11,9 +11,9 @@ Displays the information on an offer as stored on the blockchain. ## Syntax ``` -./spctl offers get-info \ - [--save-to ] \ - [--config ] \ +./spctl offers get-info + [--save-to ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/get-option.md b/docs/cli/commands/offers/get-option.md index f354c8fd..207fd5ac 100644 --- a/docs/cli/commands/offers/get-option.md +++ b/docs/cli/commands/offers/get-option.md @@ -11,10 +11,10 @@ Displays the information on a [configuration option](/fundamentals/slots) of a c ## Syntax ``` -./spctl offers get-option \ - --offer \ - --option \ - [--config ] \ +./spctl offers get-option + --offer + --option + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/get-slot.md b/docs/cli/commands/offers/get-slot.md index 5f927d50..16e489e4 100644 --- a/docs/cli/commands/offers/get-slot.md +++ b/docs/cli/commands/offers/get-slot.md @@ -13,11 +13,11 @@ Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all s ## Syntax ``` -./spctl offers get-slot \ - --offer \ - --slot \ - [--save-to ] \ - [--config ] \ +./spctl offers get-slot + --offer + --slot + [--save-to ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/get.md b/docs/cli/commands/offers/get.md index 0be6bb41..ffacbee7 100644 --- a/docs/cli/commands/offers/get.md +++ b/docs/cli/commands/offers/get.md @@ -11,9 +11,9 @@ Displays information on an offer. ## Syntax ``` -./spctl offers get \ - [--save-to ] \ - [--config ] \ +./spctl offers get + [--save-to ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/list.md b/docs/cli/commands/offers/list.md index 253d1ac6..91c63603 100644 --- a/docs/cli/commands/offers/list.md +++ b/docs/cli/commands/offers/list.md @@ -11,12 +11,12 @@ Displays a list of available offers. ## Syntax ``` -./spctl offers list \ - [--fields ,[,...]] \ - [--ids [ ...]] \ - [--limit ] \ - [--cursor ] \ - [--config ] \ +./spctl offers list + [--fields ,[,...]] + [--ids [ ...]] + [--limit ] + [--cursor ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/update-slot.md b/docs/cli/commands/offers/update-slot.md index 75dcfae5..1645b1e0 100644 --- a/docs/cli/commands/offers/update-slot.md +++ b/docs/cli/commands/offers/update-slot.md @@ -17,11 +17,11 @@ Refer to [Offer requirements] to create the initial offer requirements. Refer to ## Syntax ``` -./spctl offers update-slot \ - --offer \ - --slot \ - [--path ] \ - [--config ] \ +./spctl offers update-slot + --offer + --slot + [--path ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/offers/update.md b/docs/cli/commands/offers/update.md index 0a9f2094..955ea08d 100644 --- a/docs/cli/commands/offers/update.md +++ b/docs/cli/commands/offers/update.md @@ -15,9 +15,9 @@ Refer to the [Providers and Offers] guide to create the initial offer descriptio ## Syntax ``` -./spctl offers update \ - [--path ] \ - [--config ] \ +./spctl offers update + [--path ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/orders/cancel.md b/docs/cli/commands/orders/cancel.md index ad835ddf..35dda5d6 100644 --- a/docs/cli/commands/orders/cancel.md +++ b/docs/cli/commands/orders/cancel.md @@ -10,8 +10,8 @@ Cancels an order. ## Syntax ``` -./spctl orders cancel \ - [--config ] \ +./spctl orders cancel + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/orders/download-result.md b/docs/cli/commands/orders/download-result.md index 920f7c49..66c8fc31 100644 --- a/docs/cli/commands/orders/download-result.md +++ b/docs/cli/commands/orders/download-result.md @@ -17,9 +17,9 @@ If the order status is `Error`, the result archive will contain a text file with ## Syntax ``` -./spctl orders download-result \ - [--save-to ] \ - [--config ] \ +./spctl orders download-result + [--save-to ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/orders/get.md b/docs/cli/commands/orders/get.md index 6ac0953c..9750cb6c 100644 --- a/docs/cli/commands/orders/get.md +++ b/docs/cli/commands/orders/get.md @@ -12,11 +12,11 @@ This command allows you to check any order, not only yours. The information on a ## Syntax ``` -./spctl orders get \ - [--fields ,[,...]] \ - [--suborders] \ - [--suborders_fields ,[,...]] \ - [--config ] \ +./spctl orders get + [--fields ,[,...]] + [--suborders] + [--suborders_fields ,[,...]] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/orders/list.md b/docs/cli/commands/orders/list.md index 3f9081ac..3a483ee6 100644 --- a/docs/cli/commands/orders/list.md +++ b/docs/cli/commands/orders/list.md @@ -12,14 +12,14 @@ This command displays a list of all orders and suborders, unless the `--my-accou ## Syntax ``` -./spctl orders list \ - [--fields ,[,...]] \ - [--my-account] \ - [--type {tee | storage | solution | data}] \ - [--save-to ] \ - [--limit ] \ - [--cursor ] \ - [--config ] \ +./spctl orders list + [--fields ,[,...]] + [--my-account] + [--type {tee | storage | solution | data}] + [--save-to ] + [--limit ] + [--cursor ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/orders/replenish-deposit.md b/docs/cli/commands/orders/replenish-deposit.md index 28325e16..bb49dbc4 100644 --- a/docs/cli/commands/orders/replenish-deposit.md +++ b/docs/cli/commands/orders/replenish-deposit.md @@ -12,8 +12,8 @@ Certain orders require a positive deposit balance to keep running. ## Syntax ``` -./spctl orders replenish-deposit \ - [--config ] \ +./spctl orders replenish-deposit + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/providers/get.md b/docs/cli/commands/providers/get.md index 36f16a6d..538a4965 100644 --- a/docs/cli/commands/providers/get.md +++ b/docs/cli/commands/providers/get.md @@ -10,9 +10,9 @@ Displays the information on a provider using its authority account address. ## Syntax ``` -./spctl providers get \ - [--fields ,[,...]] \ - [--config ] \ +./spctl providers get + [--fields ,[,...]] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/providers/list.md b/docs/cli/commands/providers/list.md index 746e9da6..406f9e9c 100644 --- a/docs/cli/commands/providers/list.md +++ b/docs/cli/commands/providers/list.md @@ -10,9 +10,9 @@ Lists all registered providers. ## Syntax ``` -./spctl providers list \ - [--fields ,[,...]] \ - [--config ] \ +./spctl providers list + [--fields ,[,...]] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/providers/update.md b/docs/cli/commands/providers/update.md index 3fdb11ac..811e698d 100644 --- a/docs/cli/commands/providers/update.md +++ b/docs/cli/commands/providers/update.md @@ -14,9 +14,9 @@ Provider Tools creates a provider info JSON file in [Step 4 of the Providers and ## Syntax ``` -./spctl providers update \ - [--path ] \ - [--config ] \ +./spctl providers update + [--path ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/quotes/validate.md b/docs/cli/commands/quotes/validate.md index 11a2bc62..dec4a452 100644 --- a/docs/cli/commands/quotes/validate.md +++ b/docs/cli/commands/quotes/validate.md @@ -10,8 +10,8 @@ Checks if the domain content runs in a confidential environment. The command als ## Syntax ``` -./spctl quotes validate \ - [--config ] \ +./spctl quotes validate + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/solutions/generate-key.md b/docs/cli/commands/solutions/generate-key.md index 627dceb8..32474d8d 100644 --- a/docs/cli/commands/solutions/generate-key.md +++ b/docs/cli/commands/solutions/generate-key.md @@ -12,8 +12,8 @@ Docker needs this key to [pack a solution](/cli/commands/solutions/prepare) into ## Syntax ``` -./spctl solutions generate-key \ - [--config ] \ +./spctl solutions generate-key + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/solutions/prepare.md b/docs/cli/commands/solutions/prepare.md index 914c1865..6d4ee8a0 100644 --- a/docs/cli/commands/solutions/prepare.md +++ b/docs/cli/commands/solutions/prepare.md @@ -27,18 +27,18 @@ Note that the base image is graminized but not included in the output archive fi ## Syntax ``` -./spctl solutions prepare \ - [--base-image-path ] \ - [--metadata ] \ - [--pack-solution ] \ - [--write-default-manifest] \ - [--env [--env ...]] \ - [--hash-algo ] \ - [--sgx-max-threads ] \ - [--sgx-enclave-size ] \ - [--sgx-loader-internal-size ] \ - [--sgx-stack-size ] \ - [--config ] \ +./spctl solutions prepare + [--base-image-path ] + [--metadata ] + [--pack-solution ] + [--write-default-manifest] + [--env [--env ...]] + [--hash-algo ] + [--sgx-max-threads ] + [--sgx-enclave-size ] + [--sgx-loader-internal-size ] + [--sgx-stack-size ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/tokens/balance.md b/docs/cli/commands/tokens/balance.md index 71d39e91..171a7f4b 100644 --- a/docs/cli/commands/tokens/balance.md +++ b/docs/cli/commands/tokens/balance.md @@ -10,8 +10,8 @@ Displays the balance of TEE and POL tokens in your wallet. ## Syntax ``` -./spctl tokens balance \ - [--config ] \ +./spctl tokens balance + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/tokens/request.md b/docs/cli/commands/tokens/request.md index 205eb807..aa222997 100644 --- a/docs/cli/commands/tokens/request.md +++ b/docs/cli/commands/tokens/request.md @@ -12,10 +12,10 @@ This command is only available during the Testnet. Be mindful of [Testnet limita ## Syntax ``` -./spctl tokens request \ - [--tee] \ - [--matic] \ - [--config ] \ +./spctl tokens request + [--tee] + [--matic] + [--config ] [--help | -h] ``` @@ -26,7 +26,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax). | **Name** | **Description** | | :- | :- | | `--tee` | Request for Super Protocol TEE tokens. | -| `--matic` | Request for Polygon Amoy POL tokens. | +| `--matic` | Request for Polygon POL tokens. | | `--config ` | Path to the SPCTL configuration file. The default is `./config.json`. | | `--help`, `-h` | Help for the command. | diff --git a/docs/cli/commands/workflows/create.md b/docs/cli/commands/workflows/create.md index 5410f65f..df4a8fdf 100644 --- a/docs/cli/commands/workflows/create.md +++ b/docs/cli/commands/workflows/create.md @@ -14,17 +14,17 @@ For solutions and data, you can add to an order either Marketplace [offers](/fun ## Syntax ``` -./spctl workflows create \ - --solution {,[] | } [--solution ...] \ - --storage ,[] \ - [--data {,[] | }] [--data ...] \ - [--tee ,[]] \ - [--tee-slot-count ] \ - [--tee-options [ ...]] \ - [--tee-options-count [ ...]] \ - [--deposit ] \ - [--min-rent-minutes ] \ - [--config ] \ +./spctl workflows create + --solution {,[] | } [--solution ...] + --storage ,[] + [--data {,[] | }] [--data ...] + [--tee ,[]] + [--tee-slot-count ] + [--tee-options [ ...]] + [--tee-options-count [ ...]] + [--deposit ] + [--min-rent-minutes ] + [--config ] [--help | -h] ``` diff --git a/docs/cli/commands/workflows/generate-key.md b/docs/cli/commands/workflows/generate-key.md index 7c112ed4..70a4dd17 100644 --- a/docs/cli/commands/workflows/generate-key.md +++ b/docs/cli/commands/workflows/generate-key.md @@ -12,8 +12,8 @@ SPCTL generates this key automatically during the [configuration](/cli). Use thi ## Syntax ``` -./spctl workflows generate-key \ - [--config ] \ +./spctl workflows generate-key + [--config ] [--help | -h] ``` diff --git a/docs/cli/index.md b/docs/cli/index.md index bce3d476..ab636750 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -63,8 +63,8 @@ You can also skip the `./spctl setup` command completely and set up SPCTL manual "accessToken": "" }, "blockchain": { - "rpcUrl": "https://amoy.polygon.superprotocol.com/hesoyam", - "smartContractAddress": "0x589c5F093524e9a6cD4bAEe786859bC6C3e38bec", + "rpcUrl": "https://polygon.superprotocol.com/", + "smartContractAddress": "0x3C69ea105Fc716C1Dcb41859281Aa817D0A0B279", "accountPrivateKey": "" }, "storage": { @@ -125,8 +125,8 @@ Use the following `config.json` template: "accessToken": "" }, "blockchain": { - "rpcUrl": "https://amoy.polygon.superprotocol.com/hesoyam", - "smartContractAddress": "0x589c5F093524e9a6cD4bAEe786859bC6C3e38bec", + "rpcUrl": "https://polygon.superprotocol.com/", + "smartContractAddress": "0x3C69ea105Fc716C1Dcb41859281Aa817D0A0B279", "accountPrivateKey": "", "authorityAccountPrivateKey": "" }, diff --git a/docs/developers/cli_guides/assets/config.json b/docs/developers/cli_guides/assets/config.json index 093b358d..de748988 100644 --- a/docs/developers/cli_guides/assets/config.json +++ b/docs/developers/cli_guides/assets/config.json @@ -4,8 +4,8 @@ "accessToken": "" }, "blockchain": { - "rpcUrl": "https://amoy.polygon.superprotocol.com/hesoyam", - "smartContractAddress": "0x589c5F093524e9a6cD4bAEe786859bC6C3e38bec", + "rpcUrl": "https://polygon.superprotocol.com/", + "smartContractAddress": "0x3C69ea105Fc716C1Dcb41859281Aa817D0A0B279", "accountPrivateKey": "" }, "storage": { diff --git a/docs/developers/cli_guides/providers_offers.md b/docs/developers/cli_guides/providers_offers.md index 1bd8ec55..271087f6 100644 --- a/docs/developers/cli_guides/providers_offers.md +++ b/docs/developers/cli_guides/providers_offers.md @@ -186,7 +186,7 @@ Select `Yes`. `Do you need to generate a new TokenReceiver account?`
Select `Yes`. -Alternatively, you can use previously created Polygon accounts. Create them through MetaMask and then follow [this guide](https://docs.polygon.technology/tools/wallets/metamask/add-polygon-network/) to add the Polygon Amoy Testnet network. Select `No` in the menu when asked to generate new accounts and enter their private keys. +Alternatively, you can use previously created accounts. Select `No` and enter their private keys. Import these accounts to MetaMask using their private keys to get their addresses and better control over the balances. diff --git a/docs/fundamentals/orders.md b/docs/fundamentals/orders.md index 26304f0d..50989ceb 100644 --- a/docs/fundamentals/orders.md +++ b/docs/fundamentals/orders.md @@ -2,7 +2,7 @@ id: "orders" title: "Orders" slug: "/orders" -sidebar_position: 4 +sidebar_position: 3 --- _Orders_ and _suborders_ on Super Protocol are digital contracts between a customer and [offer](/fundamentals/offers) providers. The term _order_ always implies the usage of a [compute offer](/fundamentals/offers#compute). Every other offer added to the order creates a separate suborder related to the main order. Solutions and data uploaded by the customer create no suborders. diff --git a/docs/fundamentals/slots.md b/docs/fundamentals/slots.md index 270df4d3..61bdaf7f 100644 --- a/docs/fundamentals/slots.md +++ b/docs/fundamentals/slots.md @@ -2,7 +2,7 @@ id: "slots" title: "Slots and Options" slug: "/slots" -sidebar_position: 3 +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. diff --git a/docs/marketplace/guides/index.md b/docs/marketplace/guides/index.md index 37c4bce7..5da6e6ab 100644 --- a/docs/marketplace/guides/index.md +++ b/docs/marketplace/guides/index.md @@ -9,7 +9,8 @@ sidebar_position: 2 | :- | :- | | [How to Log In](/marketplace/guides/log-in) | Log in as a Web3 user and set up the account. | | [How to Place an Order](/marketplace/guides/place-order) | Build and place an order using a model from **Marketplace** or **My Content**. | -| [How to Upload Content](/marketplace/guides/upload) | Select a model, archive it, and upload it to Super Protocol. | +| [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. | +| [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. | | [How to 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 diff --git a/docs/marketplace/guides/log-in.md b/docs/marketplace/guides/log-in.md index 6714aa50..a84be73d 100644 --- a/docs/marketplace/guides/log-in.md +++ b/docs/marketplace/guides/log-in.md @@ -77,7 +77,7 @@ To log in as a Web3 user, you need the MetaMask browser extension. MetaMask is o -## Step 2. Add the Amoy testnet +## Step 2. Add the Polygon network Open the MetaMask window. @@ -85,31 +85,9 @@ Open the MetaMask window.

-Open the menu in the top-left corner and press **Add a custom network**. +Open the menu in the top-left corner, find Polygon Mainnet in the list of the additional networks, and click **Add**. - -
-
- -Set the following parameters and press **Save**: - -| **Field** | **Value** | -| :- | :- | -| Network name | Amoy | -| New RPC URL | https://amoy.polygon.superprotocol.com/hesoyam | -| Chain ID | 80002 | -| Currency symbol | POL | -| Block explorer URL | https://www.oklink.com/amoy | - -You can change the network name if you like. - - -
-
- -Switch to the newly added network. - - +
## Step 3. Connect the account @@ -137,33 +115,21 @@ If you connect successfully, you will see your account address in the top-right
-## Step 4. Get testnet tokens +## Step 4. Get tokens Super Protocol users need two types of tokens: - TEE tokens to pay and receive payments in Super Protocol. -- POL tokens to pay for Polygon's Amoy blockchain transactions. +- POL tokens to pay for Polygon's blockchain transactions. -Both types are necessary to place orders. During the testnet, Super Protocol provides free tokens for testing purposes. To request them, open the **Account** setting. +Both types are necessary to place orders. During the testnet, you can request free TEE tokens in the **Account** setting.

-Click the **Get TEE** and **Get POL** buttons. You will get tokens in a couple of minutes. - - -
-
- There is a limit to the daily amount of tokens you can get. Refer to the [Testnet Limitations](/marketplace/limitations). -:::warning - -Do not send TEE and POL tokens to other accounts. Violators will be banned from using the Super Protocol Marketplace. - -::: - ## Contact Super Protocol If you face any issues, do not hesitate to contact the Super Protocol team on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistan \ No newline at end of file diff --git a/docs/marketplace/guides/place-order.md b/docs/marketplace/guides/place-order.md index 1e8ed82a..01943721 100644 --- a/docs/marketplace/guides/place-order.md +++ b/docs/marketplace/guides/place-order.md @@ -30,7 +30,7 @@ Select a model you want to deploy. You can add either a model from the Marketpla - To add your own model, you must prepare and upload it first. Read [How to Upload a Model](/marketplace/guides/upload) for step-by-step instructions. + To add your own model, you must prepare and upload it first. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions. When your model is uploaded, open **My Files** and click the blue **[+]** button next to a model to add it to the order. diff --git a/docs/marketplace/guides/storage.md b/docs/marketplace/guides/storage.md index 39fd22b1..63efd812 100644 --- a/docs/marketplace/guides/storage.md +++ b/docs/marketplace/guides/storage.md @@ -2,7 +2,7 @@ id: "storage" title: "How to Set Up Personal Storage" slug: "/guides/storage" -sidebar_position: 5 +sidebar_position: 6 --- This guide provides step-by-step instructions on how to set up your personal Storj account. @@ -25,12 +25,14 @@ If you don't already have a [Storj](https://www.storj.io/) account, register one ## Step 3. Generate S3 Access Keys -In the Storj dashboard, generate two S3 Access Keys for the bucket. Assign **Write** and **Delete** permissions to one key. Assign **Read** permission to the other key. Note that each S3 Access Key comes with a corresponding Secret Key: +In the Storj dashboard, generate two S3 Access Keys for the bucket. Refer to the [Storj documentation](https://storj.dev/dcs/getting-started#generate-s3-compatible-credentials) to learn how to do it. + +Assign **Read** permission to one key. Assign **Full** permission (**Read**, **List**, **Write**, and **Delete**) to the other key. Note that each S3 Access Key comes with a corresponding Secret Key: - Example Access Key: `jv7ke2m5vqkyxffywr3qmc47ibxa`. - Example Secret Key: `jzbf5fgqz56nlun2jht7pjoiapmowvb3uarpzeqb2t2wiivij3jvg`. -As a result, you should have two pairs Access Key + Secret Key. Refer to the Storj documentation to learn how to [generate S3 Access Keys](https://storj.dev/dcs/getting-started#generate-s3-compatible-credentials). +As a result, you should have two pairs Access Key + Secret Key. ## Step 4. Set up your Super Protocol Web3 account @@ -46,9 +48,9 @@ Select the **Your Storj account** radio button, fill in the fields, and click ** | :- | :- | | Bucket | Name of the Storj bucket | | Path | Path to a directory inside the bucket; it can be empty | -| WriteAccessKeyId | Access Key with **Write** and **Delete** permissions | -| WriteSecretAccessKey | Secret Key with **Write** and **Delete** permissions | -| ReadAccessKeyId | Access Key with **Read** permissions | +| WriteAccessKeyId | Access Key with **Full** permission | +| WriteSecretAccessKey | Secret Key with **Full** permission | +| ReadAccessKeyId | Access Key with **Read** permission | | ReadSecretAccessKey | Secret Key with **Read** permissions | diff --git a/docs/marketplace/guides/upload-comfyui.md b/docs/marketplace/guides/upload-comfyui.md new file mode 100644 index 00000000..d373da3e --- /dev/null +++ b/docs/marketplace/guides/upload-comfyui.md @@ -0,0 +1,235 @@ +--- +id: "upload-comfyui" +title: "How to Upload Your Model (ComfyUI)" +slug: "/guides/upload-comfyui" +sidebar_position: 5 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +This guide provides step-by-step instructions for uploading a model supported by **ComfyUI** to Super Protocol. If your model is supported by Text Generation Web UI, refer to the [respective upload guide](/marketplace/guides/upload-tgwui). + +To deploy your model in Super Protocol, you need to complete the following steps: + +- [Step 1](/marketplace/guides/upload-comfyui#step-1-check-requirements): Ensure it fits the requirements and current limitations. +- [Step 2](/marketplace/guides/upload-comfyui#step-2-create-a-targz-archive): Create a TAR.GZ archive with your model files. +- [Step 3](/marketplace/guides/upload-comfyui#step-3-upload-the-archive): Upload the archive to Super Protocol. + +## Step 1. Check requirements + +Ensure your model meets the following Super Protocol requirements. + +### Model category + +You model must belong to a category supported by ComfyUI: + +- Image Classification +- Object Detection +- Image Segmentation +- Text-to-Image +- Image-to-Text +- Image-to-Image +- Image-to-Video +- Video Classification +- Text-to-Video +- Mask Generation + +If your model is from Hugging Face, ensure its _task_ matches one of the supported categories. + + +
+ +### 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. + +## Step 2. Create a TAR.GZ archive + +You can prepare your model manually or using Docker and a script provided by Super Protocol. + + + + + Prerequisits: + + - Linux or MacOS. On Windows, use the [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). + - [Docker](https://www.docker.com/) + + 1. Clone the [Super-Protocol/solutions](https://github.com/Super-Protocol/solutions/) GitHub repository to the location of your choosing: + + ``` + git clone https://github.com/Super-Protocol/solutions.git --depth 1 + ``` + + If you do not have Git installed, download and extract the [ZIP archive](https://github.com/Super-Protocol/solutions/archive/refs/heads/main.zip) with the repository. + + 2. Launch Docker Desktop or otherwise start the Docker daemon. + + 3. Go to the ComfyUI directory in the downloaded repository and run the script `start-dev-container.sh` to start a container with ComfyUI. + + If everything is fine, you will see the message `ComfyUI is running!` in the output. + + If you receive the error `bind source path does not exist`, add the directory with the repository to **File sharing** in the Docker's settings to make it available to the container. + + 4. Open http://localhost:8188/ in your browser to access the running ComfyUI if it has not opened automatically. + + 5. Load and customize the workflow. Use one of the following methods to add model files to the container: + + **Use a custom node** + + In ComfyUI, open Custom Node Manager and install a custom node to download model files. For example, [ComfyUI Model Downloader](https://github.com/ciri/comfyui-model-downloader) supports downloading models from Hugging Face and CivitAI. Download model files using the installed custom node. + + **Download directly to the container** + + Access the running container with the following command: + + ``` + docker exec -it comfyui bash + ``` + + Go to the `models` directory inside the container and download the model files to the corresponding subdirectories using the `wget` command. For example: + + ``` + wget https://huggingface.co/prompthero/openjourney/resolve/main/mdjrny-v4.safetensors + ``` + + **Copy from your computer** + + If you have the model on your computer, you can copy its files to the container using the following command: + + ``` + docker cp comfyui: + ``` + + - Replace `` with the path to a file on your computer. + - Replace `` with the path inside the container. + + For example: + + ``` + docker cp ~/Downloads/openjourney/mdjrny-v4.safetensors comfyui:/opt/ComfyUI/models/checkpoints/mdjrny-v4.safetensors + ``` + + 6. When the workflow is ready, save it (Ctrl+S). + + 7. Run the script `save-and-stop-dev-container.sh`. Wait until the script is finished, it may take a few minutes. When done, the script will create a TAR.GZ archive file with your workflow and model files in the `solutions/ComfyUI/changeset/` directory. + + + + + 1. Create a directory for the model files—the _model directory_. + + 2. In this directory, create the following subdirectory structure: + + ``` + user/default/workflows/ + user/default/ComfyUI-Manager/snapshots/ + + ``` + + Place your workflow JSON file to `user/default/workflows/` or leave the directory empty to use the ComfyUI's default text-to-image workflow. + + Leave `user/default/ComfyUI-Manager/snapshots/` empty. + + 3. If necessary, create additional subdirectories for the model files: + + ``` + models/checkpoints/ + models/clip/ + models/clip_vision/ + models/configs/ + models/controlnet/ + models/diffusers/ + models/diffusion_models/ + models/embeddings/ + models/gligen/ + models/hypernetworks/ + models/loras/ + models/photomaker/ + models/style_models/ + models/text_encoders/ + models/unet/ + models/upscale_models/ + models/vae/ + models/vae_approx/ + ``` + + 4. If necessary, create an additional subdirectory `custom_nodes` in the root of the model directory for custom nodes. + + 5. Check if the subdirectory structure inside the model directory is correct. An example of a correct structure: + + ``` + . + ├── custom_nodes + │    └── comfyui-model-downloader + │   └── ... + ├── models + │   └── checkpoints + │   └── mdjrny-v4.safetensors + └── user + └── default + ├── ComfyUI-Manager + │   └── snapshots + └── workflows + └── my-openjourney-workflow.json + ``` + + 6. Run the following command to create a TAR.GZ archive: + + ``` + tar -czvf -C . + ``` + + - Replace `` with the path and desired name of the output archive. Do not create the output archive in the model directory. + - Replace `` with the path to the model directory. + - Do not omit the dot `.` at the end of the command. + + For example: + + ``` + tar -czvf ~/models/my-model.tar.gz -C ~/models/model_directory/ . + ``` + + + + +## Step 3. Upload the archive + +In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the **My Files** screen and press the **Upload File** button. + + +
+
+ +Fill out the form: + +- **Content Name**: type the desired model name. It may be different from the archive name. Providing a meaningful name makes it easier to find the model later. +- **Category**: choose the model category from the drop-down menu. You can only choose one. +- **Engine**: choose compatible engines from the drop-down menu. Select both available options. + + +
+
+ +Click **Select tar.gz archive** and select the TAR.GZ archive file. + +:::note + +Super Protocol has [two options of decentralized storage](/marketplace/account/web3#storage) to upload your model: + +- **Super Protocol cloud** is the recommended option selected by default. It does not require a setup or any additional actions. +- **Personal Storj account** is intended for advanced users who want more control. Read [How to Set Up Personal Storage](/marketplace/guides/storage) for step-by-step instructions. + +::: + +Press **Upload** and wait for the process to complete. Do not close the window until the upload is done and the resource file is created. + + +
+ +## Contact Super Protocol + +If you face any issues, do not hesitate to contact the Super Protocol team on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new) for assistance. \ No newline at end of file diff --git a/docs/marketplace/guides/upload.md b/docs/marketplace/guides/upload-tgwui.md similarity index 77% rename from docs/marketplace/guides/upload.md rename to docs/marketplace/guides/upload-tgwui.md index 2966860b..7baa037c 100644 --- a/docs/marketplace/guides/upload.md +++ b/docs/marketplace/guides/upload-tgwui.md @@ -1,14 +1,21 @@ --- -id: "upload" -title: "How to Upload your Model" -slug: "/guides/upload" +id: "upload-tgwui" +title: "How to Upload Your Model (TGWUI)" +slug: "/guides/upload-tgwui" sidebar_position: 4 --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This guide provides step-by-step instructions for uploading a model to Super Protocol. +This guide provides step-by-step instructions for uploading a model supported by **Text Generation Web UI** to Super Protocol. If your model is supported by ComfyUI, refer to the [respective upload guide](/marketplace/guides/upload-comfyui). + +To deploy your model in Super Protocol, you need to complete the following steps: + +- [Step 1](/marketplace/guides/upload-tgwui#step-1-check-requirements): Ensure it fits the requirements and current limitations. +- [Step 2](/marketplace/guides/upload-tgwui#step-2-select-files): Prepare the model files. +- [Step 3](/marketplace/guides/upload-tgwui#step-3-create-a-targz-archive): Create a TAR.GZ archive with your model files. +- [Step 4](/marketplace/guides/upload-tgwui#step-4-upload-the-archive): Upload the archive to Super Protocol. ## Step 1. Check requirements @@ -16,22 +23,16 @@ Ensure your model meets the following Super Protocol requirements. ### Model category -You model must be supported by Text Generaion Web UI and belong to one of the following categories: - -+ Text Generation -+ Text Classification -+ Translation -+ Text2Text Generation - -:::note - -Uploading models for ComfyUI is temporarily unavailable. +You model must belong to a category supported by Text Generation Web UI: -::: +- Text Generation +- Text Classification +- Translation +- Text2Text Generation If your model is from Hugging Face, ensure its _task_ matches one of the supported categories. - +
### Model size @@ -42,18 +43,18 @@ Note that large models may perform poorly on CPU-only machines without GPU suppo ## Step 2. Select files -Model repositories contain multiple files. Often, not all of them are required. +Model repositories contain multiple files. Not all of them are required. -Create a directory for the model files—the model directory. Select files following the instructions for your model format and place them to the model directory. +Create a directory for the model files—the _model directory_. Select files following the instructions for your model format and place them to the model directory. -If multiple formats are available, choose one of them and remove the others. For example, one of the highlighted sets of files on the following screenshot should be removed: +If multiple formats are available, choose one of them and do not include the others. For example, only one of the highlighted sets of files on the following screenshot should be selected:
### GGUF and GGML -For models in these formats, the files in the repository usually contain variants of the same model with different quantization. Note that higher-bit quantization means a larger file. +For models in these formats, the files in the repository usually contain variants of the same model with different quantization. Note that higher-bit quantization leads to better model responses but a larger model file. Choose one file and place it in the model directory. For example: @@ -62,18 +63,14 @@ Choose one file and place it in the model directory. For example: ### Safetensors -Place all model files from the repository in the model directory. For example: +Place all model files from the repository in the model directory, except the hidden .git directory and the .gitattributes file. For example:
-Some repositories contain several variants of the same model. Avoid duplications to reduce upload time. For example, one of the the highlighted files on the following screenshot can be removed: - - -
-
+Some repositories contain several variants of the same model. Avoid duplications to reduce upload time. -If a single consolidated `model.safetensors` file and multiple `model-xxxxx-of-yyyyy.safetensors` files are available, choose one set and remove the other. For example, one of the highlighted sets of files on the following screenshot should be removed: +If a single consolidated `model.safetensors` file and multiple `model-xxxxx-of-yyyyy.safetensors` files are available, choose one set and do not include the other. For example, one of the highlighted sets of files on the following screenshot should be removed:
@@ -85,7 +82,7 @@ Ensure the model directory contains no hidden files and directories. Archive the - 1. On Windows, open PowerShell, navigate to the directory that contains the model directory, and run the following command: + 1. On Windows, open PowerShell, go to the directory that contains the model directory, and run the following command to create a TAR.GZ archive: ``` tar.exe -czvf @@ -139,7 +136,7 @@ Ensure the model directory contains no hidden files and directories. Archive the - 1. On Linux, open a terminal, navigate to the directory that contains the model directory, and run the following command: + 1. On Linux, open a terminal, navigate to the directory that contains the model directory, and run the following command to create a TAR.GZ archive: ``` tar -czvf @@ -193,13 +190,14 @@ Ensure the model directory contains no hidden files and directories. Archive the - 1. On macOS, open the Terminal, navigate to the directory that contains the model directory, and run the following command: + 1. On macOS, open the Terminal, navigate to the directory that contains the model directory, and run the following command to create a TAR.GZ archive: ``` tar --no-mac-metadata --no-xattrs -czvf ``` - Replace `` with the path and desired name of the output archive. Replace `` with the name of the model directory. + - Replace `` with the path and desired name of the output archive. + - Replace `` with the name of the model directory. For example: diff --git a/docs/marketplace/images/hf-safetensors-duplicates.png b/docs/marketplace/images/hf-safetensors-duplicates.png deleted file mode 100644 index be70171c..00000000 Binary files a/docs/marketplace/images/hf-safetensors-duplicates.png and /dev/null differ diff --git a/docs/marketplace/images/hf-task.png b/docs/marketplace/images/hf-task.png deleted file mode 100644 index b109e0b3..00000000 Binary files a/docs/marketplace/images/hf-task.png and /dev/null differ diff --git a/docs/marketplace/images/hf-text-generation.png b/docs/marketplace/images/hf-text-generation.png new file mode 100644 index 00000000..186eeb12 Binary files /dev/null and b/docs/marketplace/images/hf-text-generation.png differ diff --git a/docs/marketplace/images/hf-text-to-image.png b/docs/marketplace/images/hf-text-to-image.png new file mode 100644 index 00000000..4439ebec Binary files /dev/null and b/docs/marketplace/images/hf-text-to-image.png differ diff --git a/docs/marketplace/images/metamask-polygon-add.png b/docs/marketplace/images/metamask-polygon-add.png new file mode 100644 index 00000000..be52efec Binary files /dev/null and b/docs/marketplace/images/metamask-polygon-add.png differ diff --git a/docs/marketplace/images/metamask-testnet-add.png b/docs/marketplace/images/metamask-testnet-add.png deleted file mode 100644 index 23d40b93..00000000 Binary files a/docs/marketplace/images/metamask-testnet-add.png and /dev/null differ diff --git a/docs/marketplace/images/metamask-testnet-form.png b/docs/marketplace/images/metamask-testnet-form.png deleted file mode 100644 index f03abcf9..00000000 Binary files a/docs/marketplace/images/metamask-testnet-form.png and /dev/null differ diff --git a/docs/marketplace/images/metamask-testnet-switch.png b/docs/marketplace/images/metamask-testnet-switch.png deleted file mode 100644 index 29cc8c20..00000000 Binary files a/docs/marketplace/images/metamask-testnet-switch.png and /dev/null differ diff --git a/docs/marketplace/images/web3acc-teepol.png b/docs/marketplace/images/web3acc-teepol.png deleted file mode 100644 index 09896455..00000000 Binary files a/docs/marketplace/images/web3acc-teepol.png and /dev/null differ diff --git a/docs/marketplace/limitations.md b/docs/marketplace/limitations.md index 2fe63426..0f37a580 100644 --- a/docs/marketplace/limitations.md +++ b/docs/marketplace/limitations.md @@ -9,7 +9,7 @@ The testnet has a limited amount of computing resources. To ensure fair access, ## Pricing for orders -On the testnet, you can deploy models using either Intel TDX CPUs or NVIDIA H100 Tensor Core GPUs. +During the testnet, you can deploy models using either Intel TDX CPUs or NVIDIA H100 Tensor Core GPUs. Super Protocol has two types of machines: @@ -33,7 +33,7 @@ For example, a two-hour GPU order will cost approximately: ## Token limits - **Demo users** receive a one-time advance of 50 TEE tokens with no replenishment possibility. To continue testing, users must [log in with a Web3 account](/marketplace/guides/log-in). -- **Web3 users** can receive up to 35 TEE tokens and 5 POL tokens daily. At any given time, Web3 users can hold a maximum of 35 TEE tokens and 5 POL tokens in their wallets. +- **Web3 users** can receive up to 35 TEE tokens tokens daily. At any given time, Web3 users can hold a maximum of 35 TEE tokens in their wallets. ## Model limits diff --git a/docs/marketplace/my-content/my-files/index.md b/docs/marketplace/my-content/my-files/index.md index d953cc83..80511a96 100644 --- a/docs/marketplace/my-content/my-files/index.md +++ b/docs/marketplace/my-content/my-files/index.md @@ -17,7 +17,7 @@ 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](/marketplace/guides/upload) for step-by-step instructions. +The **Upload File** button opens the [**Upload Content**](/marketplace/my-content/my-files/upload-content) window. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions. The table in the middle of the screen includes the following columns: diff --git a/docs/marketplace/my-content/my-files/upload-content.md b/docs/marketplace/my-content/my-files/upload-content.md index b9b3646a..10f82940 100644 --- a/docs/marketplace/my-content/my-files/upload-content.md +++ b/docs/marketplace/my-content/my-files/upload-content.md @@ -24,4 +24,4 @@ To upload a file, fill in all the fields: You can change all this data later except for the uploaded file itself. -Note that before uploading a model or dataset, you must pack it into a TAR.GZ archive. The file will be uploaded to the storage specified in the Account settings. Read [How to Upload Content](/marketplace/guides/upload) for step-by-step instructions. \ No newline at end of file +Note that before uploading a model or dataset, you must pack it into a TAR.GZ archive. The file will be uploaded to the storage specified in the Account settings. Read [How to Upload Your Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload Your Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions. \ No newline at end of file