Skip to content

Commit 8dc5b3f

Browse files
ckunkiArBridgeman
andauthored
#337 ensured correct spelling for ai lab (#442)
* #337: Ensured correct spelling for AI Lab * Shortened docker-usage.md Added mounting docker.sock for SLC. * Updated version number in docs and also fixed spelling of 3rd party trademarks in README. Co-authored-by: Ariel Schulz <[email protected]>
1 parent d2e64b5 commit 8dc5b3f

File tree

64 files changed

+198
-200
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+198
-200
lines changed

.github/ISSUE_TEMPLATE/release.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Create Release
3-
about: Create a new release of the AI-Lab
3+
about: Create a new release of the AI Lab
44
title: "\U0001F4E6 Create Release <version>"
55
labels: task
66
assignees: ''
@@ -19,11 +19,10 @@ Always
1919
* latest file `doc/changes/changes_*.md`
2020
* [ ] Append release date to first line
2121
* [ ] Add a code name and a summary
22-
* Update version number in user guide
22+
* Update version number
2323
* [ ] `user_guide/docker/docker-usage.md`
2424
* [ ] `user_guide/vm-edition/win-vbox.md`
25-
* Update version number in developer guide
26-
* [ ] `testing.md`
25+
* [ ] `developer_guide/testing.md`
2726
* Replace dependencies to unreleased version (e.g. git dependencies) in files, see instructions in [notebooks.md](https://github.com/exasol/ai-lab/blob/main/doc/developer_guide/notebooks.md):
2827
* [ ] [notebook_requirements.txt](https://github.com/exasol/ai-lab/blob/main/exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook_requirements.txt)
2928
* [ ] [jupyter_requirements.txt](https://github.com/exasol/ai-lab/blob/main/exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/jupyter_requirements.txt)

.github/workflows/notebook_tests.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,14 @@ jobs:
6666

6767
- uses: ./.github/actions/prepare_test_env/
6868

69-
- name: Download ai-lab image ${{matrix.nb_test.wip}}
69+
- name: Download AI Lab image ${{matrix.nb_test.wip}}
7070
id: download-image
7171
uses: actions/download-artifact@v5
7272
with:
7373
name: "${{ env.DOCKER_IMG_ARTIFACT }}"
7474
path: "."
7575

76-
- name: Load ai-lab image ${{matrix.nb_test.wip}}
76+
- name: Load AI Lab image ${{matrix.nb_test.wip}}
7777
run: docker load -i "./$DOCKER_IMG_FILENAME"
7878

7979
- name: Run notebook tests

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Exasol AI-Lab
1+
# Exasol AI Lab
22

3-
The Exasol AI-Lab is a pre-configured container designed to empower data scientists. It streamlines common data science and AI tasks, including data loading, preparation, exploration, model training, and deployment. Whether you’re a seasoned practitioner or just getting started, the AI-Lab provides a hassle-free experience.
3+
The Exasol AI Lab is a pre-configured container designed to empower data scientists. It streamlines common data science and AI tasks, including data loading, preparation, exploration, model training, and deployment. Whether you’re a seasoned practitioner or just getting started, the AI Lab provides a hassle-free experience.
44

5-
![Transformers Extension](https://github.com/exasol/ai-lab/blob/3.3.0/doc/user_guide/ai-lab-screenshot.png)
5+
![Transformers Extension](https://github.com/exasol/ai-lab/blob/4.0.0/doc/user_guide/ai-lab-screenshot.png)
66

77
Key Features:
8-
* Jupyter Notebook Environment: The heart of the AI-Lab is a robust Jupyter Notebook environment. It’s where you’ll work on your data science projects.
9-
* Exasol Integration: Leverage Exasol’s power for your AI and machine learning use cases. The AI-Lab includes essential Exasol packages, extensions, and configuration tasks.
10-
* Example Notebooks: Jumpstart your work with ready-to-use example notebooks. Explore classic machine learning scenarios (think scikit-learn), seamlessly integrate Exasol with AWS Sagemaker, and tap into Huggingface models directly within Exasol.
8+
* Jupyter Notebook Environment: The heart of the AI Lab is a robust Jupyter Notebook environment. It’s where you’ll work on your data science projects.
9+
* Exasol Integration: Leverage Exasol’s power for your AI and machine learning use cases. The AI Lab includes essential Exasol packages, extensions, and configuration tasks.
10+
* Example Notebooks: Jumpstart your work with ready-to-use example notebooks. Explore classic machine learning scenarios (think scikit-learn), seamlessly integrate Exasol with AWS SageMaker, and tap into Hugging Face models directly within Exasol.
1111

12-
Feel free to explore the Exasol AI-Lab and unleash your data science potential!
12+
Feel free to explore the Exasol AI Lab and unleash your data science potential!
1313

14-
The AI-Lab is available in multiple [Editions](https://github.com/exasol/ai-lab/blob/3.3.0/doc/user_guide/editions.md) involving different technology stacks, see also common [System Requirements](https://github.com/exasol/ai-lab/blob/3.3.0/doc/user_guide/system-requirements.md).
14+
The AI Lab is available in multiple [Editions](https://github.com/exasol/ai-lab/blob/4.0.0/doc/user_guide/editions.md) involving different technology stacks, see also common [System Requirements](https://github.com/exasol/ai-lab/blob/4.0.0/doc/user_guide/system-requirements.md).
1515

16-
After downloading the required files and having started the AI-Lab you can connect to AI-Lab's [Jupyter Service](https://github.com/exasol/ai-lab/blob/3.3.0/doc/user_guide/jupyter.md).
16+
After downloading the required files and having started the AI Lab you can connect to AI Lab's [Jupyter Service](https://github.com/exasol/ai-lab/blob/4.0.0/doc/user_guide/jupyter.md).
1717

1818
## Additional Links
1919

2020
* [Troubleshooting](doc/user_guide/troubleshooting.md)
21-
* [Developer Guide](https://github.com/exasol/ai-lab/blob/3.3.0/doc/developer_guide/developer_guide.md)
21+
* [Developer Guide](https://github.com/exasol/ai-lab/blob/4.0.0/doc/developer_guide/developer_guide.md)

doc/changes/changes_4.1.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AI-Lab 4.0.0 released 2025-11-26
1+
# AI-Lab 4.1.0 released ????-??-??
22

33
Code name:
44

@@ -7,3 +7,4 @@ Code name:
77
## Documentation
88

99
* #432: Fixed structure and links in notebook first-steps
10+
* #337: Ensured correct spelling for AI Lab

doc/developer_guide/aws.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## How to Release the AI-Lab
1+
## How to Release the AI Lab
22

33
1. Take care to update latest file `doc/changes/changes_*.md`
44
* Correct version number
@@ -81,4 +81,4 @@ The command tags only the dynamically created entities with the *asset-id* but n
8181

8282
The command `show-aws-assets` lists all assets which were created during the execution.
8383
* This is very useful if an error occured.
84-
* If the creation of a sandbox finished normally the list should contain only the AMI, images (S3 objects) and the export tasks (one for each image).
84+
* If the creation of a sandbox finished normally the list should contain only the AMI, images (S3 objects) and the export tasks (one for each image).

doc/developer_guide/commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ The following commands can be used to deploy the infrastructure onto a given AWS
5454
* `setup-waf`: Deploy an AWS cloudformation stack with a Web Application Firefall (WAF ACL) configuration for the Cloudfront distribution of an S3 bucket, requires option `--purpose` (see below).
5555

5656
Option `--purpose` is required for both commands `setup-s3-bucket` and `setup-s3-bucket-waf` to select the purpose of the s3 bucket. Supported values are
57-
* `vm` for virtual machine images of the AI-Lab
58-
* `example-data-http` for example data to be used in the AI-Lab and accessed via HTTP.
57+
* `vm` for virtual machine images of the AI Lab
58+
* `example-data-http` for example data to be used in the AI Lab and accessed via HTTP.
5959
* `example-data-s3` for example data to be used via S3 protocol.
6060

6161
For all deployment commands:

doc/developer_guide/dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Multiple Types of Dependencies
44

5-
AI-Lab contains dependencies on multiple levels and specified in multiple places, each requiring specific steps for [updating dependencies](#updating-dependencies).
5+
AI Lab contains dependencies on multiple levels and specified in multiple places, each requiring specific steps for [updating dependencies](#updating-dependencies).
66

77
* [pyproject.toml](https://github.com/exasol/ai-lab/blob/main/pyproject.toml) and [poetry.lock](https://github.com/exasol/ai-lab/blob/main/poetry.lock)
88
* Requirements files in ansible scripts

doc/developer_guide/design_goals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Design Goals
22

3-
The Exasol AI-Lab (XAIL) uses AWS as backend, because it provides the possibility to run the whole workflow during a ci-test.
3+
The Exasol AI Lab (XAIL) uses AWS as backend, because it provides the possibility to run the whole workflow during a ci-test.
44

55
This project uses
66

doc/developer_guide/developer_guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Exasol AI-Lab Developer Guide
1+
# Exasol AI Lab Developer Guide
22

33
## Overview
44

@@ -17,4 +17,4 @@ the virtual image formats.
1717
7. [Dependencies and Updating Packages](dependencies.md)
1818
8. [Notebooks](notebooks.md)
1919

20-
Section [Dependencies](dependencies.md) is dedicated to enumerating all places defining dependencies as the AI-Lab contains dependencies on multiple levels and specified in multiple places.
20+
Section [Dependencies](dependencies.md) is dedicated to enumerating all places defining dependencies as the AI Lab contains dependencies on multiple levels and specified in multiple places.

doc/developer_guide/notebooks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Notebook Files
22

3-
AI-Lab repository includes some Jupyter notebooks and scripts to add these notebooks to AI-Lab images (the old name - DSS images), e.g. AMI or Docker Images.
3+
AI Lab repository includes some Jupyter notebooks and scripts to add these notebooks to AI Lab images (the old name - DSS images), e.g. AMI or Docker Images.
44

55
Please add or update the notebook files in folder [exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook](../../exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook).
66

77
## Notebook Connector
88

99
Most notebooks use the `exasol-notebook-connector` - the component providing various helper functions for notebooks.
10-
We typically put there the code we don't want to show in a notebook. Logically, this component is a part of the AI-Lab.
10+
We typically put there the code we don't want to show in a notebook. Logically, this component is a part of the AI Lab.
1111
It is listed in the [notebook_requirements.txt](../../exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook_requirements.txt) and gets installed in the container with pip.
1212
In order to simplify making simultaneous changes to both notebooks and the notebook-connector we allow referencing the latter temporarily through a git dependency,
1313
e.g. `exasol-notebook-connector @ git+https://github.com/exasol/notebook-connector@e3a8525`.
1414
It is important to reference a commit in the `main` branch, not the `main` branch itself. The git dependency should be
15-
replaced with the proper pypi dependency before releasing of the AI-Lab.
15+
replaced with the proper pypi dependency before releasing of the AI Lab.
1616

1717
## Work-in-progress Notebooks
1818

@@ -50,4 +50,4 @@ However, with the following pytest commandline parameters you can keep them or r
5050
Name and version of existing Docker image for Notebook testing to use for tests
5151
--keep-docker-image-notebook-test
5252
Keep the created notebook-test docker image for inspection or reuse.
53-
```
53+
```

0 commit comments

Comments
 (0)