Skip to content

Commit

Permalink
Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
balajialg committed Oct 13, 2023
1 parent d9c66d1 commit cb97c20
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ parts:
- file: workflow/dowload_PDF.md
title: Download Jupyter Notebook as PDF
- file: workflow/performance_issue.md
title: Resolving Performance Issues While Using Datahub
title: Best Practices to Avoid Performance Issues

- caption: Getting Started with Modules and Connectors
chapters:
Expand Down
6 changes: 3 additions & 3 deletions workflow/performance_issue.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Solving hub performance issues
# Best Practices to Avoid Performance Issues in Datahub

Certain large courses or courses with complex software/compute requirements can consume lot of memory/cpu which can result in poor user experience for students and/or increased cloud costs. Some of the commonly reported performance issues are due to one or many of the following reasons,

- Students are printing large data frames to a notebook directly or trying show a table that is too large in a notebook cell. The way to solve this issue is to recommend students to not print large data directly in their notebook. You can slice the dataframe to a smaller sample that you can share with your students to explore further. Please always review your datasets and remove parts of data that are not core to achieving the required learning outcomes for student
- Students are running a Python/R/Julia code containing an infinite loop. You can ask students to review their code constantly to check if they are running an infinite loop. You can ask students to reach out to you/your team if they have problem with the code. You can also check with the infra team to identify the problematic user notebooks and do the necessary code review to solve this issue.
- Students are printing large data frames to a notebook directly or trying show a table that is too large in a notebook cell. The way to solve this issue is to recommend students to not print large data directly to a cell in their notebook. In addition, You can slice the datasets to a smaller samples that students don't run into issues even if they print the entire dataset (not ideal). Please always review your datasets and remove parts of data that are not core to achieving the required learning outcomes for students
- Students are running a Python/R/Julia code containing an infinite loop. You can ask students to review their code constantly to check if they are running an infinite loop. You can ask students to reach out to you/your team if they believe that they have issues related to infinite loop in their code. If no one reached out, You can also check with the infra team to identify the problematic user notebooks and do the necessary code review to solve this issue (Re: admin access).
- Students are joining tables that are large. Once again, try to break down the dataset to subset that is of interest to achieve the course objectives.
- Students are having multiple notebooks open at the same time across one or many browsers. If students report errors such as 503, 401 error codes etc.. ask them to check if they have notebooks open in multiple tabs. As a best practice, please ask students to have a single active tab with a notebook and close other tabs.
- You upgraded to the latest version of a package without testing it extensively (e.g.: Otter grader). As a rule of thumb, upgrade packages in staging environment and test the notebooks extensively. Only when you feel comfortable with the updated environment, ask the infra team to upgrade to the latest package version in the stable environment. If you are unsure of the URL for staging environment for the hub you use for teaching purposes then ask the infra team.
Expand Down

0 comments on commit cb97c20

Please sign in to comment.