#19: move slc notebook to repo ai lab #300
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
ckunki
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
force-pushed
the
feature/19_move_slc_notebook_to_repo_ai_lab
branch
from
5765a67 to
4a92697
Compare
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
tomuben
commented
Jul 12, 2024
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook_requirements.txt
Outdated
Show resolved
Hide resolved
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
ckunki
requested changes
Jul 15, 2024
...e/ansible/roles/jupyter/files/notebook/script_languages_container/configure_slc_flavor.ipynb
Outdated
Show resolved
Hide resolved
Comment on lines
16
to
17
| "Prior to using this notebook the following steps need to be completed:\n", | ||
| "1. [Configure the AI-Lab](../main_config.ipynb).\n", |
There was a problem hiding this comment.
Shouldn't configuring the flavor path be part of configuring the AI-Lab?
How do other notebooks handle potentially specific steps of configuration?
There was a problem hiding this comment.
No, the basic configuration (setting up the DB) is done in the main_config, but specific configuration steps are in the particular notebooks. See sagemaker and transformer extensions
| "metadata": {}, | ||
| "source": [ | ||
| "# Load UI functions\n", | ||
| "Let's import some other UI functions that may be used in this notebook." |
There was a problem hiding this comment.
Suggested change
| "Let's import some other UI functions that may be used in this notebook." | |
| "Let's import some additional UI functions in order to use them in this notebook." |
...e/ansible/roles/jupyter/files/notebook/script_languages_container/configure_slc_flavor.ipynb
Outdated
Show resolved
Hide resolved
...e/ansible/roles/jupyter/files/notebook/script_languages_container/configure_slc_flavor.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
| "By running `pip list` directly in the container, we see what is currently available in the container. However, sometimes this might not be what we expected. For these cases, exaslct stores information about the flavor the container was build from within the container.\n", | ||
| "\n", | ||
| "#### Embedded Build Information of the Container\n", | ||
| "Here we see an overview about the build information which exaslct embedded into the container. `exaslct` stores all packages lists (as defined in the flavor and what actually got installed), the final Dockerfiles and the image info. The image info describes how the underlying Docker images of the container got built. The build information is stored in the `/build_info` directory in the container. We can use again our helper UDF to inspect the build information." |
There was a problem hiding this comment.
Suggested change
| "Here we see an overview about the build information which exaslct embedded into the container. `exaslct` stores all packages lists (as defined in the flavor and what actually got installed), the final Dockerfiles and the image info. The image info describes how the underlying Docker images of the container got built. The build information is stored in the `/build_info` directory in the container. We can use again our helper UDF to inspect the build information." | |
| "Here we see an overview about the build information provided embedded by `exaslct` into the container. `exaslct` stores all packages lists (as defined in the flavor and what actually got installed), the final Dockerfiles and the image info. The image info describes how the underlying Docker images of the container got built. The build information is stored in the `/build_info` directory in the container. We can use again our helper UDF to inspect the build information." |
There was a problem hiding this comment.
Hm, "...provided embedded..." is somehow duplicated....
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
ahsimb
reviewed
Jul 15, 2024
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,704 @@ | |||
| { | |||
There was a problem hiding this comment.
We don't mention the notebook connector elsewhere in the AI-Lab. Personally I am not sure it was the right approach. I feel like we demonstrate what is obvious and hide what is not. Anyway, if we go into details here, we should probably explain what exaslct is.
Reply via ReviewNB
There was a problem hiding this comment.
After the split up, I added a comment about exalct and a reference to the GH repo. Pls check.
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,704 @@ | |||
| { | |||
There was a problem hiding this comment.
Depending on your assumption about the user's level of knowledge on the subject, you may want to explain what the flavour is. Since you started the notebook with the explanation what the language container is you probably don't expect a great deal of prior knowledge.
Reply via ReviewNB
There was a problem hiding this comment.
After the split up, I added some more information to the "export_as_is.ipynb". Please take a look and let me know what you think.
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
...s/jupyter/files/notebook/script_languages_container/using_a_script_languages_container.ipynb
Outdated
Show resolved
Hide resolved
1. Added comment in export about how to download the tar gz file in Jupyter IDE 2. Added a comment about warnings in customize.ipynb 3. Changed default alias 4. Use Schema for SQL connection from nb-connector
tomuben
force-pushed
the
feature/19_move_slc_notebook_to_repo_ai_lab
branch
from
559b1e8 to
481164c
Compare
tomuben
had a problem deploying
to
approve-test-execution
GitHub Actions
Failure
ckunki
requested changes
Jul 22, 2024
| "id": "c1dc4885-42ca-47d6-800c-302b6cfc91d1", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "This notebooks explains some details and background regarding `exaslct`. This is especially useful when:\n", |
There was a problem hiding this comment.
Suggested change
| "This notebooks explains some details and background regarding `exaslct`. This is especially useful when:\n", | |
| "This notebooks explains some details and background regarding the tool `exaslct`. This is especially useful when:\n", |
Comment on lines
49
to
50
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | ||
| "This class has some utility functions which simplifies the use of the exaslct API." |
There was a problem hiding this comment.
Suggested change
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | |
| "This class has some utility functions which simplifies the use of the exaslct API." | |
| "The \"Script-Languages-Container-Tools\" Manager (SLCT Manager) simplifies using the API of `exaslct`\n", | |
| "The following cell will therefore create an instance class `SlctManager` from the notebook-connector." |
There was a problem hiding this comment.
fixed in all notebooks...
| "source": [ | ||
| "## What to do if something doesn't work?\n", | ||
| "\n", | ||
| "During the build, export or upload it can happen that external package repositories are not available or something is wrong on your machine where you run the build. For these cases, exaslct stores information in many logs that can help to identify the problem.\n", |
There was a problem hiding this comment.
Suggested change
| "During the build, export or upload it can happen that external package repositories are not available or something is wrong on your machine where you run the build. For these cases, exaslct stores information in many logs that can help to identify the problem.\n", | |
| "During the build, export or upload it can happen that external package repositories are not available or something is wrong on your machine running the build. For these cases, `exaslct` provides extensive log files that can help analyzing such problems.\n", |
| "During the build, export or upload it can happen that external package repositories are not available or something is wrong on your machine where you run the build. For these cases, exaslct stores information in many logs that can help to identify the problem.\n", | ||
| "\n", | ||
| "#### Exaslsct Log\n", | ||
| "The main log for exaslct is stored directly as main.log in the build output of the job. With the following command you can find the main logs for all previous executions." |
There was a problem hiding this comment.
Suggested change
| "The main log for exaslct is stored directly as main.log in the build output of the job. With the following command you can find the main logs for all previous executions." | |
| "The main log file for exaslct is stored as file `main.log` in the build output of the job. With the following command you can find the main logs for all previous executions." |
| "id": "ce4be726-86ad-487c-9d76-705c360b825e", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "The following command showd the log file from the last execution." |
There was a problem hiding this comment.
Suggested change
| "The following command showd the log file from the last execution." | |
| "The following command shows the log file of the last execution." |
| "source": [ | ||
| "The syntax of the activation statement is: `alias=url`. The activation key will be used in the `ALTER_SESSION` or `ALTER_SYSTEM` commands to \"register\" the script-language-container for usage in the UDF's.\n", | ||
| "\n", | ||
| "You could get the activation SLQ command on the command line with `exaslct` by running:\n", |
There was a problem hiding this comment.
Suggested change
| "You could get the activation SLQ command on the command line with `exaslct` by running:\n", | |
| "You can generate the SQL commands for the activation with the following command line:\n", |
| "source": [ | ||
| "# Export the flavor as is\n", | ||
| "\n", | ||
| "In this tutorial you will learn how to build the script-languages-container from the base flavor (without any modifiction) and write the result to a tar gz file. The base flavor `template-Exasol-all-python-3.10` is part of the Script-Languages Release repository and it's purpose is to be the base for customer modifications which aim to use Python UDF's with Python packages which are not included in the Standard Container of the Exasol database.\n", |
There was a problem hiding this comment.
Suggested change
| "In this tutorial you will learn how to build the script-languages-container from the base flavor (without any modifiction) and write the result to a tar gz file. The base flavor `template-Exasol-all-python-3.10` is part of the Script-Languages Release repository and it's purpose is to be the base for customer modifications which aim to use Python UDF's with Python packages which are not included in the Standard Container of the Exasol database.\n", | |
| "Exasol [User Defined Functions](https://docs.exasol.com/db/latest/database_concepts/udf_scripts.htm) (UDFs) enable embedding Python code into SQL statements. Each Python UDF runs in a so-called [script-languages-container](https://docs.exasol.com/db/latest/database_concepts/udf_scripts/adding_new_packages_script_languages.htm) (SLC). Exasol provides default SLCs with some preinstalled PYthon packages but also allows users to create their own SLCs, e.g. by adding additional dependencies.\n\n", | |
| "This tutorial shows how to build a script-languages-container (SLC) from a base flavor (without any modification) and write the result to a tar gz file. The base flavor `template-Exasol-all-python-3.10` is part of the Script-Languages Release repository.", |
Comment on lines
42
to
43
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | ||
| "This class has some utility functions which simplifies the use of the exaslct API." |
There was a problem hiding this comment.
Suggested change
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | |
| "This class has some utility functions which simplifies the use of the exaslct API." | |
| "The \"Script-Languages-Container-Tools\" Manager (SLCT Manager) simplifies using the API of `exaslct`\n", | |
| "The following cell will therefore create an instance class `SlctManager` from the notebook-connector." |
| "id": "31029b4f-df19-464b-91c7-2981dee02d12", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Import some utility functions\n" |
There was a problem hiding this comment.
Suggested change
| "### Import some utility functions\n" | |
| "### Import Some Utility Functions\n" |
Comment on lines
43
to
44
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | ||
| "This class has some utility functions which simplifies the use of the exaslct API." |
There was a problem hiding this comment.
Suggested change
| "We create an instance of the SlctManager class from the notebook connector. SLCT Manager, which stands for \"Script-Languages-Container-Tools\" Manager. \n", | |
| "This class has some utility functions which simplifies the use of the exaslct API." | |
| "The \"Script-Languages-Container-Tools\" Manager (SLCT Manager) simplifies using the API of `exaslct`\n", | |
| "The following cell will therefore create an instance class `SlctManager` from the notebook-connector." |
tomuben
temporarily deployed
to
approve-test-execution
GitHub Actions
Inactive
ckunki
approved these changes
Jul 23, 2024
tomuben
temporarily deployed
to
approve-test-execution
GitHub Actions
Inactive
tomuben
temporarily deployed
to
approve-test-execution
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #19