Skip to content

Conversation

@SammyOina
Copy link
Contributor

@SammyOina SammyOina commented Aug 20, 2025

What type of PR is this?

What does this do?

This PR comprehensively updates tutorial documentation across multiple AI algorithms to modernize the setup process and improve user experience. The updates introduce standardized virtual environment setup, streamlined installation procedures, and consistent documentation structure.

Replace manual computation server setup with the modern CVMS (Computation Management Server) approach
Add structured prerequisites, setup instructions, and consistent section organization
Update package versions and improve clarity of instructions throughout all tutorials

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

Did you document any new/modified features?

Notes

… CLI commands

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
…p instructions

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
…n setup and usage instructions

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
…nstructions and clarifying dataset details

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
@SammyOina SammyOina self-assigned this Aug 20, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR comprehensively updates tutorial documentation across multiple AI algorithms to modernize the setup process and improve user experience. The updates introduce standardized virtual environment setup, streamlined installation procedures, and consistent documentation structure.

  • Replace manual computation server setup with the modern CVMS (Computation Management Server) approach
  • Add structured prerequisites, setup instructions, and consistent section organization
  • Update package versions and improve clarity of instructions throughout all tutorials

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
rul-turbofan/README.md Major restructure with CVMS integration, improved setup flow, and enhanced testing sections for RUL prediction tutorial
fraud-detection/README.md Updated to use CVMS workflow, added virtual environment setup, and streamlined the fraud detection process documentation
covid19/README.md Modernized COVID-19 classification tutorial with CVMS, updated PyTorch versions, and improved structure
burn-algorithms/COCOS.md Complete rewrite using CVMS approach, added table of contents, and simplified the burn algorithm examples workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

…and correctness

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
…argo.toml files

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
… by unwrapping the result

Signed-off-by: Sammy Oina <sammyoina@gmail.com>
@dborovcanin dborovcanin merged commit 6ce28cd into ultravioletrs:main Aug 21, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants