Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the troubleshooting section in the user guide #270

Merged
merged 3 commits into from
Apr 11, 2024
Merged

Added the troubleshooting section in the user guide #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8485c6a
Added the troubleshooting.md
ahsimb Apr 10, 2024
3f5ada7
Addressed review comments [run-notebook-tests]
ahsimb Apr 10, 2024
0bf76ed
Addressed review comments [run-notebook-tests]
ahsimb Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ After downloading the required files and having started the AI-Lab you can conne

## Additional Links

* [Troubleshooting](doc/user_guide/troubleshooting.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move it above the developer guide, because Troubleshooting is more important for the user then the developer guide

* [Developer Guide](https://github.com/exasol/ai-lab/blob/2.0.0/doc/developer_guide/developer_guide.md)
2 changes: 1 addition & 1 deletion doc/changes/changes_2.1.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ n/a

## Documentation

n/a
* #249: Added a troubleshooting section to the user guide documenting died kernel for transformers/te_init.ipynb.

## Refactoring

Expand Down
18 changes: 18 additions & 0 deletions doc/user_guide/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Troubleshooting

## Kernel died when initializing the Transformers Extension

### Problem

Running the Transformers Extension Initialization in the transformers/te_init.ipynb notebook results
in a pop-up error message similar to this: "Kernel Restarting. The kernel for transformers/te_init.ipynb
appears to have died. It will restart automatically."

### Cause

The issue is caused by an insufficient memory, either RAM or the free disk space. This, for example,
can be observed when running the AI-Lab from certain restricted EC2 instances, e.g.T2.medium.

### Solution

Make sure the available resources satisfy the minimum [system requirements](system-requirements.md).
Loading