1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00

GITBOOK-341: change request with no subject merged in GitBook

This commit is contained in:
mariacarmina.cretu 2023-05-30 10:33:35 +00:00 committed by gitbook-bot
parent 184ef2a170
commit 2c8178fd62
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
15 changed files with 40 additions and 19 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 320 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

View File

@ -1,10 +1,10 @@
---
description: Help for wherever you are on your Ocean Protocol journey.
cover: .gitbook/assets/cover/contribute (1) (1).png
cover: .gitbook/assets/cover/contribute (1).png
coverY: 0
layout: landing
---
# 👋 Welcome
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card (1).png">developer_tutorials_card (1).png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card (1).png">data_science_card (1).png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card (1).png">infrastructure_card (1).png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/defi_card.png">defi_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card (1).png">contribute_card (1).png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card (1).png">discover_card (1).png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card (1).png">user_guides_card (1).png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card.png">developer_tutorials_card.png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/defi_card.png">defi_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card (1).png">rewards_card (1).png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>

View File

@ -27,7 +27,7 @@
* [Harvest More Yield Data Farming](user-guides/how-to-data-farm.md)
* [Claim Rewards Data Farming](user-guides/claim-ocean-rewards.md)
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md)
* [👨💻 Developers](developers/README.md)
* [👨💻 👨💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md)
* [Data NFTs and Datatokens](developers/datanft-and-datatoken/README.md)
* [Data NFTs](developers/datanft-and-datatoken/data-nfts.md)

View File

@ -48,7 +48,7 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed-
### High-Level Behavior
![High-Level Flow](<../../.gitbook/assets/architecture/high-level-flow (1).png>)
![High-Level Flow](../../.gitbook/assets/architecture/high-level-flow.png)
Here's an example.

View File

@ -12,6 +12,27 @@ Well, brace yourselves for some exhilarating news! Introducing ocean.py, a Pytho
ocean.py serves as a connection layer bridging the V4 smart contracts and various components such as Provider, Aquarius, and Compute to Data engine within Ocean Protocol. This pythonic library brings all these elements together, facilitating seamless integration and interaction. By acting as an intermediary, ocean.py enables developers to easily leverage the functionalities offered by Ocean Protocol, making it a valuable tool in building applications and solutions that utilize decentralized data marketplaces. Its purpose is to simplify the process of connecting with smart contracts and accessing services provided by Provider, Aquarius, and Compute to Data engine, providing a convenient and efficient development experience for users.
#### Architectural point of view
Oh, the wondrous world of ocean.py! Imagine a playful octopus with eight arms, each one specialized in a unique task. 🐙
At its heart, ocean.py is like the conductor of an underwater orchestra, guiding different marine creatures (modules) to work together harmoniously. It's an open-source library that makes swimming in the vast sea of data a breeze! 🌊
The head of our octopus is the "Ocean" class. It oversees everything and keeps track of the data flow. It's like the brain of our underwater friend! 🧠
Now, let's take a closer look at those amazing arms:
1. Data Sources Arm: This arm gathers data from various sources, like CSV files, databases, or even streaming platforms. It dives deep to bring us the precious information we seek.
2. Data Cleaning Arm: Ah, the tidy arm! It takes messy data and polishes it, removing any inconsistencies or errors. It's like our octopus's personal cleaner, making sure everything is spotless.
3. Data Transformation Arm: This arm is like a shape-shifter! It takes the cleaned data and transforms it into a more suitable format for analysis. It can pivot, filter, or aggregate the data, molding it like clay.
4. Model Training Arm: Time for some deep learning! This arm is responsible for training machine learning models on the transformed data. It uses powerful algorithms to find patterns and make predictions, just like a clever cephalopod.
5. Model Evaluation Arm: Our octopus likes to double-check its work! This arm evaluates the trained models to see how accurate and reliable they are. It helps ensure our models are as reliable as an expert swimmer.
6. Model Deployment Arm: Ready to release our models into the ocean? This arm takes the trained models and deploys them, making them accessible for real-time predictions. It's like releasing beautiful sea creatures back into their natural habitat.
7. Model Monitoring Arm: Once the models are swimming freely, this arm keeps an eye on them. It checks their performance, detects any anomalies, and helps our octopus make timely adjustments if needed. Safety first!
8. Visualization Arm: Last but not least, our octopus has a creative side too! This arm helps create stunning visualizations of the data and model results. It turns numbers into beautiful underwater artworks.
So there you have it, the playful world of ocean.py, where an octopus and its eight specialized arms dive into the depths of data to unravel its mysteries. Happy swimming! 🌊🐙
### ocean.py Strengths 💪
ocean.py lets you do the following things:

View File

@ -6,7 +6,7 @@ description: Fundamental knowledge of using ERC-20 crypto wallets.
Ocean Protocol users require an ERC-20 compatible wallet to manage their OCEAN and ETH tokens. In this guide, we will provide some recommendations for different wallet options.
<figure><img src="../.gitbook/assets/whats-a-wallet (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
### What is a wallet?

View File

@ -28,7 +28,7 @@ Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the numb
Also, select the region where you want Aquarius to be hosted and a root password.
![Select region](../.gitbook/assets/server-setup/server-setup3.png)
![Select region](<../.gitbook/assets/server-setup/server-setup3 (1).png>)
![Click create Droplet](../.gitbook/assets/server-setup/server-setup4.png)

View File

@ -18,41 +18,41 @@ Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might al
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
![Select storage accounts](<../../.gitbook/assets/hosting/azure1 (1).png>)
![Select storage accounts](../../.gitbook/assets/hosting/azure1.png)
**Create a new storage account**
![Create a storage account](../../.gitbook/assets/hosting/azure2.png)
![Create a storage account](<../../.gitbook/assets/hosting/azure2 (1).png>)
**Fill in the details**
![Add details](<../../.gitbook/assets/hosting/azure3 (1).png>)
![Add details](../../.gitbook/assets/hosting/azure3.png)
**Storage account created**
![Storage account created](../../.gitbook/assets/hosting/azure4.png)
![Storage account created](<../../.gitbook/assets/hosting/azure4 (1).png>)
**Step 2 - Create a blob container**
![Create a blob container](<../../.gitbook/assets/hosting/azure5 (1).png>)
![Create a blob container](../../.gitbook/assets/hosting/azure5.png)
**Step 3 - Upload a file**
![Upload a file](../../.gitbook/assets/hosting/azure6.png)
![Upload a file](<../../.gitbook/assets/hosting/azure6 (1).png>)
**Step 4 - Share the file**
**Select the file to be published and click Generate SAS**
![Click generate SAS](<../../.gitbook/assets/hosting/azure7 (1).png>)
![Click generate SAS](../../.gitbook/assets/hosting/azure7.png)
**Configure the SAS details and click `Generate SAS token and URL`**
![Generate link to file](../../.gitbook/assets/hosting/azure8.png)
![Generate link to file](<../../.gitbook/assets/hosting/azure8 (1).png>)
**Copy the generated link**
![Copy the link](../../.gitbook/assets/hosting/azure9.png)
![Copy the link](<../../.gitbook/assets/hosting/azure9 (1).png>)
**Step 5 - Publish the asset using the generated link**

View File

@ -14,7 +14,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](get-veocean-
Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page.
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab (1).png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️

View File

@ -50,7 +50,7 @@ description: How to publish a C2D algorithm NFT on the Ocean Market
* Your preview should look like the following:
<figure><img src="../../.gitbook/assets/c2d/preview-publish (1).png" alt="" width="375"><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/c2d/preview-publish.png" alt="" width="375"><figcaption></figcaption></figure>
#### Step 8 - Submit the transactions

View File

@ -78,7 +78,7 @@ description: How to publish a data NFT with C2D configurations
#### Congratulations! You have fully finished the C2D flow. Check your work by verifying that your algorithm appears on the data NFT's page, like in the following example:
<figure><img src="../../.gitbook/assets/c2d/double-check-work.png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/c2d/double-check-work (1).png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
If you would like to run the compute job, then simply click the radio button to the left of the algorithm's name and click Buy Compute Job.

View File

@ -14,7 +14,7 @@ Liquidity pools and dynamic pricing used to be supported in previous versions of
4\. Go to field `20. balanceOf` and insert your ETH address. This will retrieve your pool share token balance in wei.
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-2 (1) (1) (2).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-2 (1) (1) (2) (1) (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
5\. Copy this number as later you will use it as the `poolAmountIn` parameter.