Skip to content
Merged

Stage #243

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/developers/cli_guides/providers_offers.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,6 @@ The `register` command initiates a series of steps:
2. Provider Tools checks whether the provider with the Authority Account specified in `provider-tools-config.json` is already registered on the blockchain.
+ If the provider exists, the prompt will go to the next step.
+ If the provider does not exist, Provider Tools asks you to create one. Specify the desired provider name and write a short description. Provider Tools also prompts you to save the provider info to a JSON file in case you need to [update](/developers/cli_guides/providers_offers#update-provider-info) the provider description later.
+ If the provider does not exist, Provider Tools asks you to create one. Specify the desired provider name and write a short description. Provider Tools also prompts you to save the provider info to a JSON file in case you need to [update](/developers/cli_guides/providers_offers#update-provider-info) the provider description later.

3. Provider Tools asks if this provider already has a solution or data offer created on the blockchain. If you want to create a new offer, select `No`. Provider Tools then asks for the `offer-info.json` and `offer-slot.json` from [Step 3](/developers/cli_guides/providers_offers#step-3-configure-the-offer).

Expand Down
8 changes: 4 additions & 4 deletions docs/marketplace/guides/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: "storage"
title: "How to Set Up Personal Storage"
slug: "/guides/storage"
sidebar_position: 4
sidebar_position: 5
---

This guide provides step-by-step instructions on how to set up your personal Storj account.
Expand All @@ -25,7 +25,7 @@ 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** and **List** permissions 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. 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:

- Example Access Key: `jv7ke2m5vqkyxffywr3qmc47ibxa`.
- Example Secret Key: `jzbf5fgqz56nlun2jht7pjoiapmowvb3uarpzeqb2t2wiivij3jvg`.
Expand All @@ -48,8 +48,8 @@ Select the **Your Storj account** radio button, fill in the fields, and click **
| 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** and **List** permissions |
| ReadSecretAccessKey | Secret Key with **Read** and **List** permissions |
| ReadAccessKeyId | Access Key with **Read** permissions |
| ReadSecretAccessKey | Secret Key with **Read** permissions |

<img src={require('../images/web3acc-storj.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: "troubleshooting"
title: "Troubleshooting"
slug: "/guides/troubleshooting"
sidebar_position: 6
sidebar_position: 99
---

This page contains the most common issues and ways to fix them. This list is incomprehensive and is constantly updated.
Expand Down
134 changes: 102 additions & 32 deletions docs/marketplace/guides/upload.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: "upload"
title: "How to Upload a Model"
title: "How to Upload your Model"
slug: "/guides/upload"
sidebar_position: 3
sidebar_position: 4
---

import Tabs from '@theme/Tabs';
Expand All @@ -16,24 +16,18 @@ Ensure your model meets the following Super Protocol requirements.

### Model category

You model must belong to a category supported by one of the engines:

- **Text Generation Web UI** supports models that involve text-based chats:
+ Text Generation
+ Text Classification
+ Translation
+ Text2Text Generation
- **ComfyUI** supports various image- and video-related tasks:
+ 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
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.

:::

If your model is from Hugging Face, ensure its _task_ matches one of the supported categories.

Expand All @@ -42,7 +36,7 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support

### Model size

The size of your model should not exceed 10 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future.
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.

Expand Down Expand Up @@ -91,7 +85,7 @@ Ensure the model directory contains no hidden files and directories. Archive the
<Tabs>
<TabItem value="windows" label="Windows" default>

On Windows, open PowerShell, navigate to the directory that contains the model directory, and run the following command:
1. On Windows, open PowerShell, navigate to the directory that contains the model directory, and run the following command:

```
tar.exe -czvf <ARCHIVE_FILE> <MODEL_DIRECTORY>
Expand All @@ -106,22 +100,46 @@ Ensure the model directory contains no hidden files and directories. Archive the
tar.exe -czvf my-model.tar.gz my-model
```

Wait for the process to complete; it may take a few minutes.
2. Wait for the process to complete; it may take a few minutes.

Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:
3. Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:

```
tar.exe -tzvf <ARCHIVE_FILE>
```

- Replace `<ARCHIVE_FILE>` with the name of the archive.

Alternatively, install a file archiver like [7-Zip](https://www.7-zip.org/) or similar to create a TAR.GZ archive using a graphical user interface instead of a command line.
An example of a **correct** directory structure inside the archive:

```
my-model\
my-model\tokenizer_config.json
my-model\added_tokens.json
my-model\model.safetensors
my-model\special_tokens_map.json
my-model\tokenizer.json
my-model\generation_config.json
my-model\config.json
```

An example of an **incorrect** directory structure inside the archive:

```
Downloads\models\my-model\
Downloads\models\my-model\tokenizer_config.json
Downloads\models\my-model\added_tokens.json
Downloads\models\my-model\model.safetensors
Downloads\models\my-model\special_tokens_map.json
Downloads\models\my-model\tokenizer.json
Downloads\models\my-model\generation_config.json
Downloads\models\my-model\config.json
```

</TabItem>
<TabItem value="linux" label="Linux">

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:

```
tar -czvf <ARCHIVE_FILE> <MODEL_DIRECTORY>
Expand All @@ -136,20 +154,46 @@ Ensure the model directory contains no hidden files and directories. Archive the
tar -czvf mymodel.tar.gz my-model
```

Wait for the process to complete; it may take a few minutes.
2. Wait for the process to complete; it may take a few minutes.

Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:
3. Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:

```
tar -tzvf <ARCHIVE_FILE>
```
```

- Replace `<ARCHIVE_FILE>` with the name of the archive.

An example of a **correct** directory structure inside the archive:

```
my-model/
my-model/tokenizer_config.json
my-model/added_tokens.json
my-model/model.safetensors
my-model/special_tokens_map.json
my-model/tokenizer.json
my-model/generation_config.json
my-model/config.json
```

An example of an **incorrect** directory structure inside the archive:

```
Downloads/models/my-model/
Downloads/models/my-model/tokenizer_config.json
Downloads/models/my-model/added_tokens.json
Downloads/models/my-model/model.safetensors
Downloads/models/my-model/special_tokens_map.json
Downloads/models/my-model/tokenizer.json
Downloads/models/my-model/generation_config.json
Downloads/models/my-model/config.json
```

</TabItem>
<TabItem value="macos" label="macOS">

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:

```
tar --no-mac-metadata --no-xattrs -czvf <ARCHIVE_FILE> <MODEL_DIRECTORY>
Expand All @@ -163,16 +207,42 @@ Ensure the model directory contains no hidden files and directories. Archive the
tar --no-mac-metadata --no-xattrs -czvf mymodel.tar.gz my-model
```

Wait for the process to complete; it may take a few minutes.
2. Wait for the process to complete; it may take a few minutes.

Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:
3. Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive:

```
tar -tzvf <ARCHIVE_FILE>
```

- Replace `<ARCHIVE_FILE>` with the name of the archive.

An example of a **correct** directory structure inside the archive:

```
my-model/
my-model/tokenizer_config.json
my-model/added_tokens.json
my-model/model.safetensors
my-model/special_tokens_map.json
my-model/tokenizer.json
my-model/generation_config.json
my-model/config.json
```

An example of an **incorrect** directory structure inside the archive:

```
Downloads/models/my-model/
Downloads/models/my-model/tokenizer_config.json
Downloads/models/my-model/added_tokens.json
Downloads/models/my-model/model.safetensors
Downloads/models/my-model/special_tokens_map.json
Downloads/models/my-model/tokenizer.json
Downloads/models/my-model/generation_config.json
Downloads/models/my-model/config.json
```

</TabItem>
</Tabs>

Expand Down
14 changes: 7 additions & 7 deletions docs/marketplace/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ Super Protocol constantly adds more TDX+H100 machines and will soon begin onboar

Pricing and restrictions:

- Order lease time: minimum 2 hours and maximum 8 hours.
- Compute costs 4.134 TEE tokens per hour for GPU orders and 2.13 TEE per hour for CPU orders in most cases.
- Order lease time: minimum 2 hours.
- Compute costs 2.126 TEE tokens in most cases.
- Models from the Marketplace cost 1 TEE per order.
- Engines cost 0.5 TEE per order.
- Tunnels Launcher fee for setting up a confidential tunnel is approximately 1-2 TEE per order.
- Tunnels Launcher fee for setting up a confidential tunnel is approximately 2 TEE per order.

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

4.134 * 4 + 1 + 0.5 + 2 = **~19-20 TEE** tokens.
2.126 * 2 + 1 + 0.5 + 2 = **~8** TEE tokens.

## 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 25 TEE tokens and 5 POL tokens daily. At any given time, Web3 users can hold a maximum of 25 TEE tokens and 5 POL tokens in their wallets.
- **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.

## Model limits

The total size of your model files should not exceed 10 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future.
The total size of your model files should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future.

Also, deployed models must belong to a category supported by one of the AI engines:

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^3.6.1",
"@docusaurus/plugin-client-redirects": "^3.6.1",
"@docusaurus/preset-classic": "^3.6.1",
"@docusaurus/core": "^3.7.0",
"@docusaurus/plugin-client-redirects": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@easyops-cn/docusaurus-search-local": "^0.38.1",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
Expand Down Expand Up @@ -49,8 +49,8 @@
]
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.6.1",
"@docusaurus/types": "^3.6.1",
"@docusaurus/module-type-aliases": "^3.7.0",
"@docusaurus/types": "^3.7.0",
"solc-0.8.4": "npm:solc@^0.8.13"
},
"engines": {
Expand Down
Loading
Loading