Skip to content

Commit

Permalink
removed all anchors, changed all links to headings
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed May 24, 2024
1 parent 72f7fdf commit 50ac22d
Show file tree
Hide file tree
Showing 16 changed files with 76 additions and 98 deletions.
11 changes: 5 additions & 6 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ The [community](https://support.teradata.com/community?id=community_forum&sys_id

### What is a project?

A project is a means to explore and analyze data from a Jupyter notebook. Each project has a Git repository.
A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account.

### How do I use a project?

In a Jupyter notebook, you create a project, which automatically creates its repository. Then you authorize access to your data store, deploy the project's AI/ML engine, and run analytic workloads. You can suspend the project (and engine) anytime, then restore it, to pay only for the hours you need.
In a Jupyter notebook, you create a project, which automatically creates its Git repository. Then you authorize access to your data store, deploy the project's AI/ML engine, and run analytic workloads. You can suspend the project (and engine) anytime, then restore it, to pay only for the hours you need.

### What's my API key for?
You use your API key to connect your Jupyter notebook to the AI Unlimited manager. This is the first thing you do when you open a new notebook to create or access a project.

### What's in a project repository?
### What's in a project's repository?

The project owner adds collaborators to the repository. From the repository, the next time the engine is deployed, the manager derives the users authorized to connect to and use the engine.
The project owner adds project collaborators to the Git repository. From there, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine.

But if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment.
But, if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment.

:::note
Each time the engine is deployed, a new password is generated for each project user.
Expand Down Expand Up @@ -94,7 +94,6 @@ It also provides a web-based user interface from which the AI Unlimited admin se

From their user profile in the manager, all users get their API key for connecting a Jupyter notebook to the manager.


:::tip
Don't see your question? Ask it in the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa)
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/explore-and-analyze-data/collaborate-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A project owner might add you to a project as a collaborator. You'll need to acc
## Before you begin

From the project owner, get these items:
- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#glo-aiu-manager)
- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#ai-unlimited-manager)
- The project name

From your profile, [get your API key](/docs/explore-and-analyze-data/get-api-key.md).
Expand Down
14 changes: 4 additions & 10 deletions docs/explore-and-analyze-data/create-first-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_label: Create your first project
sidebar_position: 2
pagination_prev: null
pagination_next: null

---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand All @@ -32,7 +32,7 @@ Your AI Unlimited admin is the person at your organization who set up AI Unlimit

- From your admin, get these items:

- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#glo-aiu-manager).
- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#ai-unlimited-manager).

- These environment variables:
<Tabs>
Expand Down Expand Up @@ -67,7 +67,6 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
1. Connect to the manager.
```bash
%workspaces_config host=<ip_or_hostname>, apikey=<API_Key>, withtls=T

```

2. Create the project.
Expand Down Expand Up @@ -103,8 +102,7 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
Make sure you do not have tables named SalesCenter or SalesDemo in the selected database. Replace `Authorization_Name` and the `salescenter.csv_file_location` values in the following example with your own values.
::::

a. Create a table to store the sales center data.

a. Create a table to store the sales center data.
```sql
DROP FOREIGN TABLE SalesCenter;
Expand All @@ -127,8 +125,7 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
NO PRIMARY INDEX;
```

b. Verify that the data was inserted.
b. Verify that the data was inserted.
```sql
SELECT * FROM SalesCenter ORDER BY 1
```
Expand Down Expand Up @@ -169,16 +166,13 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
```bash
%chart sales_center_name, sales, title=Sales Data
```

f. Drop the tables.

```sql
DROP TABLE SalesCenter;
DROP TABLE SalesDemo;
```

7. Back up your project metadata and object definitions in your Git repository.

```bash
%project_backup project=<Project_Name>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/explore-and-analyze-data/get-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pagination_next: null

# Get your API key

Each time you open a new notebook to create or access a project, you'll need your [API key.](/docs/glossary#glo-api-key) It connects your notebook to the [AI Unlimited manager](/docs/glossary#glo-aiu-manager).
Each time you open a new notebook to create or access a project, you'll need your [API key.](/docs/glossary#api-key) It connects your notebook to the [AI Unlimited manager](/docs/glossary#ai-unlimited-manager).

Your API key, available from your user profile in the manager, stays the same for the lifetime of the AI Unlimited installation.

Expand Down
4 changes: 3 additions & 1 deletion docs/explore-and-analyze-data/magic-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sidebar_position: 5
pagination_prev: null
pagination_next: null
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -284,7 +285,6 @@ Started deploying.
Success: Compute Engine setup, look at the connection manager
```


## %project_engine_suspend

**Description**: Stop the engine after you're done with your work.
Expand Down Expand Up @@ -393,6 +393,7 @@ Where:
```
Username and password of each user on the engine
```

## %project_engine_update_auth

**Description**: Update or add new authorizations on the deployed engine without having to suspend and redeploy the engine.
Expand All @@ -410,6 +411,7 @@ Where:
```
Authorizations updated
```

## %project_connection_add

**Description**: Refresh the connection for the deployed engine. Use this command to connect to the engine from another notebook without having to create a new connection manually.
Expand Down
1 change: 1 addition & 0 deletions docs/explore-and-analyze-data/project-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import ProjectFlowOwnerImg from './owner.svg';
<br />
<br />


## Project collaborators
<br />

Expand Down
46 changes: 12 additions & 34 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,129 +13,110 @@ pagination_next: null

## A

<a id="glo-aiu-manager"></a>
### AI Unlimited manager

The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#glo-engine) on your [cloud service provider](#glo-csp). It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key.
The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#engine) on your [cloud service provider](#cloud-service-provider-(csp)). It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key.

<a id="glo-api-key"></a>
### API key

Your Application Programming Interface (API) key enables you to connect your Jupyter notebook to the manager. This is the first thing you do in a new Jupyter notebook before you create or access a project.

<a id="glo-alb"></a>
### application load balancer

Load balancers distribute incoming traffic across servers. An application load balancer inspects incoming traffic content, such as HTTP headers and paths, to make routing decisions. You can use an application load balancer as a way to expose AI Unlimited manager and the engine to the public IP network.


## C

<a id="glo-cidr"></a>
### Classless Inter-Domain Routing (CIDR)

An IP address allocation method for data routing efficiency on the internet. Every computer that connects to the internet has a unique number called an IP address. IP addresses enable computers find each other and communicate. A CIDR block is a range of IP addresses.

<a id="glo-csp"></a>
### cloud service provider (CSP)

A company that delivers computing resources over the internet, on demand. These resources can include Infrastructure as a Service (IaaS), Platform as a Service (PaaS), or Software as a Service (SaaS). The [AI Unlimited manager](#glo-manager) and [engine](#glo-engine) run on your CSP.
A company that delivers computing resources over the internet, on demand. These resources can include Infrastructure as a Service (IaaS), Platform as a Service (PaaS), or Software as a Service (SaaS). The [AI Unlimited manager](#ai-unlimited-manager) and [engine](#engine) run on your CSP.

<a id="glo-cluster"></a>
### cluster

A group of interconnected computers (also called nodes) that work together as a single system for enhanced processing power, scalability, and reliability. The AI Unlimited engine is deployed on a cluster on your CSP. Each node is a [virtual machine (VM)](#glo-vm).
A group of interconnected computers (also called nodes) that work together as a single system for enhanced processing power, scalability, and reliability. The AI Unlimited engine is deployed on a cluster on your CSP. Each node is a [virtual machine (VM)](#virtual-machine-(vm)).


## D

<a id="glo-data-lake"></a>
### data lake

A central repository of data for data analytics, machine learning, and data exploration. A data lake is typically built on [object storage](#glo-object-storage) and is designed for data accessibility for future data analysis.
A central repository of data for data analytics, machine learning, and data exploration. A data lake is typically built on [object storage](#object-storage) and is designed for data accessibility for future data analysis.


## E

<a id="glo-engine"></a>
### engine

In cloud computing, a compute engine is an example of Infrastructure as a Service (IaaS). It enables you to create and run [virtual machines (VMs)](#glo-vm) on your cloud service provider's infrastructure. When you deploy the AI Unlimited AI/ML compute engine from a Jupyter notebook, the [AI Unlimited manager](#glo-manager) provisions VMs.
In cloud computing, a compute engine is an example of Infrastructure as a Service (IaaS). It enables you to create and run [virtual machines (VMs)](#virtual-machine-(vm)) on your cloud service provider's infrastructure. When you deploy the AI Unlimited AI/ML compute engine from a Jupyter notebook, the [AI Unlimited manager](#ai-unlimited-manager) provisions VMs.


## I

<a id="glo-iam-role"></a>
### IAM role

An [Identity and Access Management (IAM) role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) is a role that you or a cloud admin at your organization can create in your organization's AWS account. It has one or more attached permissions policies that determine what an entity with that role can and cannot do in AWS.


## K

<a id="glo-kernel"></a>
### kernel

A Jupyter kernel is a language-specific program that processes the code you write in a Jupyter notebook and communicates the results back to your notebook for you to see.


## L

<a id="glo-load-balancer"></a>
### load balancer

A load balancer distributes incoming traffic evenly across servers, which improves performance, reliability, and scalability. If your organization does not allow its resources to use public IP addresses, you can use a load balancer to expose the AI Unlimited manager and engine to the public IP network.


## M

<a id="glo-manager"></a>
### manager

See [AI Unlimited manager](#glo-aiu-manager).
See [AI Unlimited manager](#ai-unlimited-manager).

<a id="glo-mounting-volumes"></a>
### mounting volumes

A concept in containerized platforms such as Docker. You can map a directory on the machine running the containers (the host) to a directory in a container to share data and files between the host and container.


## N

<a id="glo-nlb"></a>
### network load balancer

Load balancers distribute incoming traffic across servers. A network load balancer does not inspect traffic content. It bases routing decisions on factors such as ports and IP addresses. You can use a network load balancer as a way to expose AI Unlimited and its engine to the public IP network.


## O

<a id="glo-oauth-app"></a>
### OAuth app

An OAuth app allows a user to grant access to their account on one website or service to another, without sharing their password.

An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitHub or GitLab authentication to manage each [project repository](#glo-project-repo) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository.
An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitHub or GitLab authentication to manage each [project repository](#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository.


<a id="glo-object-storage"></a>
### object storage
A scalable, highly effective way to store large amounts of structured, semi-structured, or unstructured data in the cloud. Amazon S3 is object storage on AWS. Azure Blob Storage is object storage on Azure. Object storage is the basis for a [data lake](#glo-data-lake).
A scalable, highly effective way to store large amounts of structured, semi-structured, or unstructured data in the cloud. Amazon S3 is object storage on AWS. Azure Blob Storage is object storage on Azure. Object storage is the basis for a [data lake](#data-lake).


## P

<a id="glo-project"></a>
### project

A project is a means to explore and analyze data from a Jupyter notebook. Each project has a Git repository.
A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account.

<a id="glo-project-repo"></a>
### project repository

The project owner adds collaborators to the repository. From the repository, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine.
The project owner adds project collaborators to the Git repository. From there, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine.

But if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment.
But, if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment.

:::note
Each time the engine is deployed, a new password is generated for each project user.
Expand All @@ -146,22 +127,19 @@ Each time you, or another user, suspends a project, its schema is backed up in t

## S

<a id="glo-systemd"></a>
### systemd

Linux foundational software for system and service management. The AI Unlimited manager runs on a server instance in a container controlled by systemd.


## T

<a id="glo-tls"></a>
### Transport Layer Security (TLS)

A protocol that creates a secure connection between two parties communicating over the internet. TLS encrypts data during transmission, making it unreadable to anyone who intercepts it, and it verifies the identities of both parties.


## V

<a id="glo-vm"></a>
## virtual machine (VM)
A software emulation of a physical computer. Each VM operates as its own computer within a [CSP](#glo-csp)'s infrastructure. VMs enable scalability, flexibility, easier management, and a pay-as-you-go model.
A software emulation of a physical computer. Each VM operates as its own computer within a [CSP](#cloud-service-provider-(csp))'s infrastructure. VMs enable scalability, flexibility, easier management, and a pay-as-you-go model.
1 change: 0 additions & 1 deletion docs/install-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ If AI Unlimited has already been installed and set up by someone at your organiz
- The [AI Unlimited Jupyter Kernel](https://downloads.teradata.com/download/tools/teradata-ai-unlimited-jupyter-kernel) for managing projects in notebooks


<a id="gs-prerequisites"></a>
## Prerequisites

- A pay-as-you-go AWS or Azure account on which to provision compute resources. See the requirements for your [AWS](/docs/resources/aws-requirements.md) or [Azure](/docs/resources/azure-requirements.md) account.
Expand Down
Loading

0 comments on commit 50ac22d

Please sign in to comment.