Skip to content

Commit b67c0d6

Browse files
authored
Doc review and rename get-additional-demos.sh to update-demos.sh
Doc review and rename get-additional-demos.sh to update-demos.sh
2 parents 00de3af + 2b753d9 commit b67c0d6

15 files changed

+629
-303
lines changed

README.md

Lines changed: 79 additions & 52 deletions
Large diffs are not rendered by default.
-2.42 KB
Binary file not shown.
-1.95 KB
Binary file not shown.

data-ingestion-and-preparation/README.ipynb

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
"- [Overview](#data-ingest-overview)\n",
1717
" - [Platform Data Containers](#platform-data-containers)\n",
1818
"- [Basic Flow](#data-ingest-basic-flow)\n",
19-
"- [Iguazio's Platform Data Layer](#data-ingest-iguazio-platform-data-layer)\n",
20-
" - [Iguazio's Data-Object API](#data-ingest-iguazio-data-object-api)\n",
21-
" - [Iguazio's Key-Value API](#data-ingest-iguazio-kv-api)\n",
22-
" - [Iguazio's Streaming API](#data-ingest-iguazio-streaming-api)\n",
19+
"- [The Platform's Data Layer](#data-ingest-platform-data-layer)\n",
20+
" - [The Data-Object Platform API](#data-ingest-platform-data-object-api)\n",
21+
" - [The NoSQL (Key-Value) Platform API](#data-ingest-platform-nosql-api)\n",
22+
" - [The Streaming Platform API](#data-ingest-platform-streaming-api)\n",
2323
"- [Reading from External Database](#data-ingest-external-dbs)\n",
2424
" - [Using Spark over JDBC](#data-ingest-spark-over-jdbs)\n",
2525
" - [Using SQLAlchemy](#data-ingest-sqlalchemy)\n",
@@ -38,7 +38,7 @@
3838
"- [Getting Data from AWS S3 Using curl](data-ingest-s3-curl)\n",
3939
"- [Running Distributed Python with Dask](#data-ingest-dask)\n",
4040
"- [Running DataFrames on GPUs using NVIDIA cuDF](#data-ingest-gpu)\n",
41-
"- [Creating Dashboards with Grafana](#data-grafana)"
41+
"- [Visualizing Data with Grafana](#data-ingest-grafana)"
4242
]
4343
},
4444
{
@@ -55,7 +55,8 @@
5555
"\n",
5656
"This tutorial provides an overview of various methods for collecting, storing, and manipulating data in the platform, and refers to sample tutorial notebooks that demonstrate how to use these methods.<br>\n",
5757
"For an in-depth overview of the platform and how it can be used to implement a full data science workflow, see the [**platform-overview**](../platform-overview.ipynb) tutorial notebook.\n",
58-
"For full end-to-end platform use-case application demos, see the [**welcome notebook**](../welcome.ipynb#end-to-end-use-case-applications)\n",
58+
"<br>\n",
59+
"For information about the available full end-to-end platform use-case application demos, see the [**welcome**](../welcome.ipynb#end-to-end-use-case-applications) notebook or the matching [**README.md**](../README.md#end-to-end-use-case-applications) file.\n",
5960
"\n",
6061
"<br><img src=\"../assets/images/pipeline-diagram.png\" alt=\"pipeline-diagram\" width=\"1000\"/><br>"
6162
]
@@ -118,79 +119,84 @@
118119
"cell_type": "markdown",
119120
"metadata": {},
120121
"source": [
121-
"<a id=\"data-ingest-iguazio-platform-data-layer\"></a>"
122+
"<a id=\"data-ingest-platform-data-layer\"></a>"
122123
]
123124
},
124125
{
125126
"cell_type": "markdown",
126127
"metadata": {},
127128
"source": [
128-
"## Iguazio's Platform Data Layer"
129+
"## The Platform's Data Layer"
129130
]
130131
},
131132
{
132133
"cell_type": "markdown",
133134
"metadata": {},
134135
"source": [
135-
"<a id=\"data-ingest-iguazio-data-object-api\"></a>"
136+
"<a id=\"data-ingest-platform-data-object-api\"></a>\n",
137+
"\n",
138+
"The platform features an extremely fast and secure data layer that supports SQL, NoSQL, time-series databases, files (simple objects), and streaming, and exposes multiple APIs for working with the different data types &mdash; including [simple-object](#data-ingest-platform-data-object-api), [NoSQL (\"key-value\")](#data-ingest-platform-nosql-api), and [streaming](#data-ingest-platform-streaming-api) APIs."
136139
]
137140
},
138141
{
139142
"cell_type": "markdown",
140143
"metadata": {},
141144
"source": [
142-
"### Iguazio's Data-Object API"
145+
"### The Data-Object Platform API"
143146
]
144147
},
145148
{
146149
"cell_type": "markdown",
147150
"metadata": {},
148151
"source": [
149-
"The platform’s Simple-Object API enables performing simple data-object operations that resembles Amazon’s Simple Storage Service (S3) API. In addition to the S3-like capabilities, the Simple-Object Web API enables appending data to existing objects. The [**v3io-objects notebook**](v3io-objects.ipynb) demonstrates the API usage."
152+
"The platform’s Simple-Object API enables performing simple data-object and container operations that resemble the Amazon Web Services (AWS) Simple Storage Service (S3) API.\n",
153+
"In addition to the S3-like capabilities, the Simple-Object Web API enables appending data to existing objects.\n",
154+
"For more information and API usage examples, see the [**v3io-objects**](v3io-objects.ipynb) tutorial."
150155
]
151156
},
152157
{
153158
"cell_type": "markdown",
154159
"metadata": {},
155160
"source": [
156-
"<a id=\"data-ingest-iguazio-kv-api\"></a>"
161+
"<a id=\"data-ingest-platform-nosql-api\"></a>"
157162
]
158163
},
159164
{
160165
"cell_type": "markdown",
161166
"metadata": {},
162167
"source": [
163-
"### Iguazio's Key-Value API"
168+
"### The NoSQL (Key-Value) Platform API"
164169
]
165170
},
166171
{
167172
"cell_type": "markdown",
168173
"metadata": {},
169174
"source": [
170-
"The platform’s Key-Value (KV) API provides access to the NoSQL database service, which enables storing and consuming data in a tabular format. The [**v3io-kv notebook**](v3io-kv.ipynb) demonstrates the API usage."
175+
"The platform’s NoSQL (a.k.a. Key-Value/KV) API provides access to the platform's NoSQL data store (database service), which enables storing and consuming data in a tabular format.\n",
176+
"For more information and API usage examples, see the [**v3io-kv**](v3io-kv.ipynb) tutorial."
171177
]
172178
},
173179
{
174180
"cell_type": "markdown",
175181
"metadata": {},
176182
"source": [
177-
"<a id=\"data-ingest-iguazio-streaming-api\"></a>"
183+
"<a id=\"data-ingest-platform-streaming-api\"></a>"
178184
]
179185
},
180186
{
181187
"cell_type": "markdown",
182188
"metadata": {},
183189
"source": [
184-
"### Iguazio's Streaming API"
190+
"### The Streaming Platform API"
185191
]
186192
},
187193
{
188194
"cell_type": "markdown",
189195
"metadata": {},
190196
"source": [
191-
"The platform’s Streaming API enables working with data in the platform as streams. The [**v3io-streams notebook**](v3io-streams.ipynb) demonstrates the API usage.\n",
192-
"\n",
193-
"For more general information see [working with Streams](#data-ingest-streams) section."
197+
"The platform’s Streaming API enables working with data in the platform as streams.\n",
198+
"For more information and API usage examples, see the [**v3io-streams**](v3io-streams.ipynb) tutorial.\n",
199+
"In addition, see the [Working with Streams](#data-ingest-streams) section in the current tutorial for general information about different methods for working with data streams in the platform."
194200
]
195201
},
196202
{
@@ -346,9 +352,11 @@
346352
"The platform's streaming engine is currently available via the platform's [Streaming Web API](https://www.iguazio.com/docs/latest-release/reference/api-reference/web-apis/streaming-web-api/).<br>\n",
347353
"In addition, the platform's Spark-Streaming Integration API enables using the Spark Streaming API to work with platform streams, as explained in the next section ([Using Spark Streaming](#data-ingest-streams-spark)).\n",
348354
"\n",
349-
"The [**v3io-streams notebook**](v3io-streams.ipynb) demonstrates basic usage of the streaming API.\n",
355+
"The [**v3io-streams**](v3io-streams.ipynb) tutorial demonstrates basic usage of the streaming API.\n",
350356
"\n",
351-
"The [**model meployment with streaming demo**](https://github.com/mlrun/demo-model-deployment-with-streaming) demo application includes an example of a Nuclio function that uses platform streams."
357+
"<!-- [IntInfo] The referenced demo deson't exist.\n",
358+
"The [**model deployment with streaming**](https://github.com/mlrun/demo-model-deployment-with-streaming) demo application includes an example of a Nuclio function that uses platform streams.\n",
359+
"-->"
352360
]
353361
},
354362
{
@@ -556,20 +564,26 @@
556564
]
557565
},
558566
{
559-
"source": [
560-
"<a id=\"data-grafana\"></a>"
561-
],
562567
"cell_type": "markdown",
563-
"metadata": {}
568+
"metadata": {},
569+
"source": [
570+
"<a id=\"data-ingest-grafana\"></a>"
571+
]
564572
},
565573
{
574+
"cell_type": "markdown",
575+
"metadata": {},
566576
"source": [
567-
"## Creating Dashboards with Grafana\n",
577+
"## Visualizing Data with Grafana\n",
568578
"\n",
569-
"You can create a Grafana dashboard programmatically using the Iguazio API. This allows you to define a dashboard that reads from the Iguazio data layer and display tables and charts of this data. The [**grafana-grafwiz example**](grafana-grafwiz.ipynb) demonstrates how to do that."
570-
],
571-
"cell_type": "markdown",
572-
"metadata": {}
579+
"The platform has a Grafana service with predefined dashboards that leverage the monitoring service to display monitoring data, such as performance statistics, for application services.\n",
580+
"You can also define custom Grafana dashboards for monitoring, visualizing, and understanding data stored in the platform, such as time-series metrics and NoSQL data.\n",
581+
"You can read and analyze data from the platform's data store and visualize it on Grafana dashboards in the desired formats, such as tables and graphs.\n",
582+
"This can be done by using the custom `iguazio` data source, or by using a Prometheus data source for running Prometheus queries on platform TSDB tables.\n",
583+
"You can also issue data alerts and create, explore, and share dashboards.\n",
584+
"\n",
585+
"You can use Iguazio's [grafwiz](https://github.com/v3io/grafwiz) Python library to create an deploy Grafana dashboards programmatically, as demonstrated in the [**grafana-grafwiz**](grafana-grafwiz.ipynb) tutorial."
586+
]
573587
}
574588
],
575589
"metadata": {
@@ -593,4 +607,4 @@
593607
},
594608
"nbformat": 4,
595609
"nbformat_minor": 4
596-
}
610+
}

data-ingestion-and-preparation/README.md

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Learn about different methods for ingesting data into the Iguazio Data Science P
55
- [Overview](#data-ingest-overview)
66
- [Platform Data Containers](#platform-data-containers)
77
- [Basic Flow](#data-ingest-basic-flow)
8-
- [Iguazio's Platform Data Layer](#data-ingest-iguazio-platform-data-layer)
9-
- [Iguazio's Data-Object API](#data-ingest-iguazio-data-object-api)
10-
- [Iguazio's Key-Value API](#data-ingest-iguazio-kv-api)
11-
- [Iguazio's Streaming API](#data-ingest-iguazio-streaming-api)
8+
- [The Platform's Data Layer](#data-ingest-platform-data-layer)
9+
- [The Data-Object Platform API](#data-ingest-platform-data-object-api)
10+
- [The NoSQL (Key-Value) Platform API](#data-ingest-platform-nosql-api)
11+
- [The Streaming Platform API](#data-ingest-platform-streaming-api)
1212
- [Reading from External Database](#data-ingest-external-dbs)
1313
- [Using Spark over JDBC](#data-ingest-spark-over-jdbs)
1414
- [Using SQLAlchemy](#data-ingest-sqlalchemy)
@@ -27,7 +27,7 @@ Learn about different methods for ingesting data into the Iguazio Data Science P
2727
- [Getting Data from AWS S3 Using curl](data-ingest-s3-curl)
2828
- [Running Distributed Python with Dask](#data-ingest-dask)
2929
- [Running DataFrames on GPUs using NVIDIA cuDF](#data-ingest-gpu)
30-
- [Creating Dashboards with Grafana](#data-grafana)
30+
- [Visualizing Data with Grafana](#data-ingest-grafana)
3131

3232
<a id="data-ingest-overview"></a>
3333
## Overview
@@ -39,7 +39,8 @@ The platform features a wide set of methods for manipulating and managing data,
3939

4040
This tutorial provides an overview of various methods for collecting, storing, and manipulating data in the platform, and refers to sample tutorial notebooks that demonstrate how to use these methods.<br>
4141
For an in-depth overview of the platform and how it can be used to implement a full data science workflow, see the [**platform-overview**](../platform-overview.ipynb) tutorial notebook.
42-
For full end-to-end platform use-case application demos, see the [**welcome notebook**](../welcome.ipynb#end-to-end-use-case-applications)
42+
<br>
43+
For information about the available full end-to-end platform use-case application demos, see the [**welcome**](../welcome.ipynb#end-to-end-use-case-applications) notebook or the matching [**README.md**](../README.md#end-to-end-use-case-applications) file.
4344

4445
<br><img src="../assets/images/pipeline-diagram.png" alt="pipeline-diagram" width="1000"/><br>
4546

@@ -77,29 +78,34 @@ For detailed information and examples on how to set the data path for each inter
7778
The [**basic-data-ingestion-and-preparation**](basic-data-ingestion-and-preparation.ipynb) tutorial walks you through basic scenarios of ingesting data from external sources into the platform's data store and manipulating the data using different data formats.
7879
The tutorial includes an example of ingesting a CSV file from an AWS S3 bucket; converting it into a NoSQL table using Spark DataFrames; running SQL queries on the table; and converting the table into a Parquet file.
7980

80-
<a id="data-ingest-iguazio-platform-data-layer"></a>
81+
<a id="data-ingest-platform-data-layer"></a>
8182

82-
## Iguazio's Platform Data Layer
83+
## The Platform's Data Layer
8384

84-
<a id="data-ingest-iguazio-data-object-api"></a>
85+
<a id="data-ingest-platform-data-object-api"></a>
8586

86-
### Iguazio's Data-Object API
87+
The platform features an extremely fast and secure data layer that supports SQL, NoSQL, time-series databases, files (simple objects), and streaming, and exposes multiple APIs for working with the different data types &mdash; including [simple-object](#data-ingest-platform-data-object-api), [NoSQL ("key-value")](#data-ingest-platform-nosql-api), and [streaming](#data-ingest-platform-streaming-api) APIs.
8788

88-
The platform’s Simple-Object API enables performing simple data-object operations that resembles Amazon’s Simple Storage Service (S3) API. In addition to the S3-like capabilities, the Simple-Object Web API enables appending data to existing objects. The [**v3io-objects notebook**](v3io-objects.ipynb) demonstrates the API usage.
89+
### The Data-Object Platform API
8990

90-
<a id="data-ingest-iguazio-kv-api"></a>
91+
The platform’s Simple-Object API enables performing simple data-object and container operations that resemble the Amazon Web Services (AWS) Simple Storage Service (S3) API.
92+
In addition to the S3-like capabilities, the Simple-Object Web API enables appending data to existing objects.
93+
For more information and API usage examples, see the [**v3io-objects**](v3io-objects.ipynb) tutorial.
9194

92-
### Iguazio's Key-Value API
95+
<a id="data-ingest-platform-nosql-api"></a>
9396

94-
The platform’s Key-Value (KV) API provides access to the NoSQL database service, which enables storing and consuming data in a tabular format. The [**v3io-kv notebook**](v3io-kv.ipynb) demonstrates the API usage.
97+
### The NoSQL (Key-Value) Platform API
9598

96-
<a id="data-ingest-iguazio-streaming-api"></a>
99+
The platform’s NoSQL (a.k.a. Key-Value/KV) API provides access to the platform's NoSQL data store (database service), which enables storing and consuming data in a tabular format.
100+
For more information and API usage examples, see the [**v3io-kv**](v3io-kv.ipynb) tutorial.
97101

98-
### Iguazio's Streaming API
102+
<a id="data-ingest-platform-streaming-api"></a>
99103

100-
The platform’s Streaming API enables working with data in the platform as streams. The [**v3io-streams notebook**](v3io-streams.ipynb) demonstrates the API usage.
104+
### The Streaming Platform API
101105

102-
For more general information see [working with Streams](#data-ingest-streams) section.
106+
The platform’s Streaming API enables working with data in the platform as streams.
107+
For more information and API usage examples, see the [**v3io-streams**](v3io-streams.ipynb) tutorial.
108+
In addition, see the [Working with Streams](#data-ingest-streams) section in the current tutorial for general information about different methods for working with data streams in the platform.
103109

104110
<a id="data-ingest-external-dbs"></a>
105111
## Reading Data from External Databases
@@ -180,9 +186,11 @@ You can use the platform's streaming engine to write data into a queue in a real
180186
The platform's streaming engine is currently available via the platform's [Streaming Web API](https://www.iguazio.com/docs/latest-release/reference/api-reference/web-apis/streaming-web-api/).<br>
181187
In addition, the platform's Spark-Streaming Integration API enables using the Spark Streaming API to work with platform streams, as explained in the next section ([Using Spark Streaming](#data-ingest-streams-spark)).
182188

183-
The [**v3io-streams notebook**](v3io-streams.ipynb) demonstrates basic usage of the streaming API.
189+
The [**v3io-streams**](v3io-streams.ipynb) tutorial demonstrates basic usage of the streaming API.
184190

185-
The [**model meployment with streaming demo**](https://github.com/mlrun/demo-model-deployment-with-streaming) demo application includes an example of a Nuclio function that uses platform streams.
191+
<!-- [IntInfo] The referenced demo deson't exist.
192+
The [**model deployment with streaming**](https://github.com/mlrun/demo-model-deployment-with-streaming) demo application includes an example of a Nuclio function that uses platform streams.
193+
-->
186194

187195
<a id="data-ingest-streams-spark"></a>
188196

@@ -284,8 +292,14 @@ The [**gpu-cudf-vs-pd**](gpu-cudf-vs-pd.ipynb) tutorial demonstrates how to use
284292
> **Note:** To use the cuDF library, you need to create a RAPIDS Conda environment.
285293
> For more information, see the [**virtual-env**](../virtual-env.ipynb) tutorial.
286294
287-
<a id="data-grafana"></a>
295+
<a id="data-ingest-grafana"></a>
288296

289-
## Creating Dashboards with Grafana
297+
## Visualizing Data with Grafana
290298

291-
You can create a Grafana dashboard programmatically using the Iguazio API. This allows you to define a dashboard that reads from the Iguazio data layer and display tables and charts of this data. The [**grafana-grafwiz example**](grafana-grafwiz.ipynb) demonstrates how to do that.
299+
The platform has a Grafana service with predefined dashboards that leverage the monitoring service to display monitoring data, such as performance statistics, for application services.
300+
You can also define custom Grafana dashboards for monitoring, visualizing, and understanding data stored in the platform, such as time-series metrics and NoSQL data.
301+
You can read and analyze data from the platform's data store and visualize it on Grafana dashboards in the desired formats, such as tables and graphs.
302+
This can be done by using the custom `iguazio` data source, or by using a Prometheus data source for running Prometheus queries on platform TSDB tables.
303+
You can also issue data alerts and create, explore, and share dashboards.
304+
305+
You can use Iguazio's [grafwiz](https://github.com/v3io/grafwiz) Python library to create an deploy Grafana dashboards programmatically, as demonstrated in the [**grafana-grafwiz**](grafana-grafwiz.ipynb) tutorial.

0 commit comments

Comments
 (0)