Skip to content

Add section in docs for facility guides - #265

Merged
Deathn0t merged 1 commit into
developfrom
facility-guides
Feb 12, 2025
Merged

Add section in docs for facility guides#265
Deathn0t merged 1 commit into
developfrom
facility-guides

Conversation

@wigging

@wigging wigging commented Feb 3, 2025

Copy link
Copy Markdown
Member

In the current documentation, the Tutorials section contains a subsection for the Argonne LCF which is not useful for general users. So this pull request moves that section to a separate section called Facility Guides.

@wigging wigging self-assigned this Feb 3, 2025
@codecov

codecov Bot commented Feb 3, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.12%. Comparing base (b82c83c) to head (1db31dc).
Report is 36 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #265      +/-   ##
===========================================
+ Coverage    41.64%   42.12%   +0.48%     
===========================================
  Files          125      125              
  Lines         8321     8311      -10     
  Branches      1359     1367       +8     
===========================================
+ Hits          3465     3501      +36     
+ Misses        4542     4488      -54     
- Partials       314      322       +8     

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

@wigging

wigging commented Feb 3, 2025

Copy link
Copy Markdown
Member Author

I have some questions for @Deathn0t regarding this pull request:

  1. In the tutorials repo, tutorials/alcf needs to be removed since that content is included in this pull request. Do you want me to remove those files or can you do it?
  2. In the tutorial repo, there is a search_with_mpi.py script in the tutorials/alcf/01_Theta directory but I don't think it is used for anything in the documentation. Can it be removed in this pull request?
  3. When I build the docs, it generates some zip files for the examples. Are those zip files needed for the documentation?

@Deathn0t

Deathn0t commented Feb 4, 2025

Copy link
Copy Markdown
Member

Hi @wigging ,

  1. Yes remove.
  2. Yes remove, Theta is a former system that is not in service anymore.
  3. If nothing was edited in deephyper/examples/ in theory, you do not need to commit these zip files. I suggest removing them from the PR.

@wigging

wigging commented Feb 10, 2025

Copy link
Copy Markdown
Member Author

As part of this pull request, also see the tutorials pull request which removes the alcf tutorials.

@wigging
wigging marked this pull request as ready for review February 10, 2025 16:32
@wigging
wigging requested a review from Deathn0t February 10, 2025 16:32
@Deathn0t
Deathn0t merged commit 935e469 into develop Feb 12, 2025
@Deathn0t
Deathn0t deleted the facility-guides branch February 12, 2025 11:41
Deathn0t added a commit that referenced this pull request Feb 17, 2025
* simplifying the decentralized search (#260)

* updating readme with license badge

* fixing checkout of tutorial in docs build

* Add uv installation page in documentation (#263)

* Add uv installation page

* Clean up comments for pip install

* updated quickstart on landing page

* adding refs to tutorials and examples

* updated landing page and installation page

* updating install titles

* updating title

* updated quick start introduction

* updated index

* updating license

* updating license badge in README

* updating authors, maintainers in toml

* updated description in toml

* add dropdown functionnality in sphinx gallery

* updating experimental design search example

* updating examples, including intersphinx

* add files for examples, update gitignore

* removing api.rst from exclude_patterns

* update intersphinx config

* adding AutoDEUQ example, adding torch and configspace to intersphinx

* updating autodeuq example

* changes for Colab tutorial (#271)

* changes for colab tutorial

* adapted code for cuda/cpu using ray evaluator, simplifying to_torch/numpy conversions, adding download of pre-computed results, added install command for notebooks

---------

Co-authored-by: Brett Eiffert <eiffertbc@ornl.gov>
Co-authored-by: Deathn0t <romainegele@gmail.com>

* adding rm command to cleanup results in example

* Add a Facility Guides section (#265)

* updated autodeuq tutorial

* update version to 0.9.2

---------

Co-authored-by: Gavin Wiggins <6828967+wigging@users.noreply.github.com>
Co-authored-by: Brett Eiffert <brettceiffert@gmail.com>
Co-authored-by: Brett Eiffert <eiffertbc@ornl.gov>
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.

2 participants