Skip to content

ci(docs): run all docs on cpu runners#1595

Merged
avik-pal merged 1 commit intomainfrom
ap/docs_full_cpu_build
Dec 9, 2025
Merged

ci(docs): run all docs on cpu runners#1595
avik-pal merged 1 commit intomainfrom
ap/docs_full_cpu_build

Conversation

@avik-pal
Copy link
Member

@avik-pal avik-pal commented Dec 9, 2025

handling secrets prevents external doc contributions

@gemini-code-assist
Copy link

Summary of Changes

Hello @avik-pal, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request modifies the continuous integration (CI) setup for building documentation. The primary goal is to shift the execution of documentation tutorials from GPU (CUDA) runners to CPU runners. This change is crucial for enabling external contributions to the documentation, as the previous setup involving secrets on GPU runners posed a barrier. By standardizing on CPU runners, the project aims to streamline the contribution process and foster broader community engagement.

Highlights

  • Documentation CI Configuration: Updated the device specification for numerous tutorials from "CUDA" to "CPU" to ensure they run on CPU runners.
  • Environment Variable Adjustment: Changed the JULIA_CUDA_HARD_MEMORY_LIMIT environment variable to JULIA_CPU_HARD_MEMORY_LIMIT to align with the switch to CPU-based documentation builds.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/Documentation.yml
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation build process to run all tutorials on CPU runners, which is a great change to facilitate external contributions. The changes to switch from 'CUDA' to 'CPU' devices and update the memory limit environment variable are correct. I've added a suggestion to improve the code formatting for the tutorial lists, which will enhance readability, especially since automatic formatting is disabled for this file.

@avik-pal avik-pal force-pushed the ap/docs_full_cpu_build branch from 1c7d392 to 9a3f482 Compare December 9, 2025 18:21
@codecov
Copy link

codecov bot commented Dec 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 19.38%. Comparing base (cfc8c09) to head (9a3f482).

❗ There is a different number of reports uploaded between BASE (cfc8c09) and HEAD (9a3f482). Click for more details.

HEAD has 48 uploads less than BASE
Flag BASE (cfc8c09) HEAD (9a3f482)
49 1
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1595       +/-   ##
===========================================
- Coverage   82.12%   19.38%   -62.75%     
===========================================
  Files         171      159       -12     
  Lines        7073     6834      -239     
===========================================
- Hits         5809     1325     -4484     
- Misses       1264     5509     +4245     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@avik-pal avik-pal merged commit bf85cee into main Dec 9, 2025
13 of 14 checks passed
@avik-pal avik-pal deleted the ap/docs_full_cpu_build branch December 9, 2025 21:07
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.

1 participant