Skip to content

core(graph): initial doc#648

Merged
dalg24 merged 1 commit into
kokkos:mainfrom
romintomasetti:graph-start
Apr 7, 2025
Merged

core(graph): initial doc#648
dalg24 merged 1 commit into
kokkos:mainfrom
romintomasetti:graph-start

Conversation

@romintomasetti
Copy link
Copy Markdown
Contributor

@romintomasetti romintomasetti commented Apr 1, 2025 •
edited
Loading

Summary

We are starting to document Kokkos::Experimental::Graph.

This PR sets the basement for it.

Joint work with @maartenarnst.

Drive-by change: ensure that the year corresponds to the moment the documentation was generated. (see #649)

Description

Some additional work was need to get graphviz working:

  1. apt install the graphviz package
  2. but the CI was running on a runner, not in a container, so I got permission denied
  3. so I added container:
  4. and pip was not found
  5. so I ended up using the python:3.10 image.

Related

@romintomasetti romintomasetti requested a review from JBludau April 1, 2025 16:12
@romintomasetti romintomasetti self-assigned this Apr 1, 2025
dalg24
dalg24 reviewed Apr 1, 2025
View reviewed changes
Comment thread docs/source/conf.py
@romintomasetti romintomasetti requested a review from dalg24 April 2, 2025 06:28
@romintomasetti romintomasetti mentioned this pull request Apr 2, 2025
Merged
@romintomasetti romintomasetti force-pushed the graph-start branch 5 times, most recently from 90a5d14 to f9664fa Compare April 2, 2025 15:02
@romintomasetti romintomasetti requested a review from crtrott April 2, 2025 15:05
@romintomasetti
Copy link
Copy Markdown
Contributor Author

romintomasetti commented Apr 2, 2025 •
edited
Loading

As discussed with @dalg24, let's give the Kokkos::Graph a decent minimal amount of documentation.

@dalg24 @JBludau @crtrott Would you have some time to review this ?

@romintomasetti romintomasetti changed the title core(graph): placeholder core(graph): initial doc Apr 2, 2025
@romintomasetti romintomasetti mentioned this pull request Apr 3, 2025
Merged
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
maartenarnst
maartenarnst reviewed Apr 3, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst Outdated
JBludau
JBludau approved these changes Apr 3, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@JBludau JBludau left a comment

Choose a reason for hiding this comment

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

looks like a good starting point

Comment thread docs/source/API/core/Graph.rst Outdated
Comment thread docs/source/API/core/Graph.rst Outdated
@romintomasetti
Copy link
Copy Markdown
Contributor Author

romintomasetti commented Apr 4, 2025

@dalg24 Would you mind taking a look ? 👓

dalg24
dalg24 reviewed Apr 4, 2025
View reviewed changes
Comment thread docs/source/API/core/Graph.rst
@romintomasetti romintomasetti requested a review from dalg24 April 4, 2025 14:02
dalg24
dalg24 reviewed Apr 4, 2025
View reviewed changes
Comment thread docs/source/programmingguide.rst
Comment thread docs/source/ProgrammingGuide/Graph.rst Outdated
@dalg24
Copy link
Copy Markdown
Member

dalg24 commented Apr 4, 2025

It is fine to add later but we also will need the API reference for it

@romintomasetti romintomasetti requested a review from dalg24 April 4, 2025 14:54
maartenarnst
maartenarnst approved these changes Apr 7, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@maartenarnst maartenarnst left a comment

Choose a reason for hiding this comment

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

OK indeed!

@dalg24 dalg24 merged commit 32d75a9 into kokkos:main Apr 7, 2025
@romintomasetti romintomasetti deleted the graph-start branch April 8, 2025 11:49
diehlpk pushed a commit to diehlpk/kokkos-core-wiki that referenced this pull request Apr 17, 2025
@romintomasetti @diehlpk
core(graph): placeholder (kokkos#648)
52c9007
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maartenarnst maartenarnst maartenarnst approved these changes

@JBludau JBludau JBludau approved these changes

@crtrott crtrott Awaiting requested review from crtrott

@dalg24 dalg24 Awaiting requested review from dalg24

Assignees

@romintomasetti romintomasetti

Labels

Required for upcoming release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@romintomasetti @dalg24 @maartenarnst @JBludau