Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sphinx porting stage2: update API pages to use sphinx syntax #120

Closed
fnrizzi opened this issue Jul 27, 2022 · 8 comments
Closed

sphinx porting stage2: update API pages to use sphinx syntax #120

fnrizzi opened this issue Jul 27, 2022 · 8 comments

Comments

@fnrizzi
Copy link
Collaborator

fnrizzi commented Jul 27, 2022 •
edited
Loading

  • make a list of the API pages/features that need to be updated in priority order
    1. View
    2. all the ones inside containers
    3. convert all parallel dispatch
    4. TBD
  • after the list is approved by the team, make PR for each one to convert it from the "old" syntax to the "new" syntax

By "new syntax" we mean the syntax that @nmm0 proposed to use, see here
@marcinwrobel1986
Copy link
Collaborator

marcinwrobel1986 commented Aug 1, 2022 •
edited by fnrizzi
Loading

updated list below

@marcinwrobel1986

This comment was marked as outdated.

Sign in to view
@fnrizzi
Copy link
Collaborator Author

fnrizzi commented Aug 16, 2022 •
edited by antoinemeyer5
Loading

highest priority:

File name Doc title Done with PR
API/core/view/view.md View #296
API/core/view/subview.md subview #144
API/core/view/view_alloc.md view_alloc() #147
API/core/view/view_like.md View-like Types #148
API/containers/Bitset.md Bitset #150
API/containers/DynamicView.md DynamicView #197
API/containers/DynRankView.md DynRankView #196
API/containers/Offset-View.md OffsetView #198
API/containers/ScatterView.md ScatterView #199
API/containers/Unordered-Map.md UnorderedMap #200
API/containers/vector.md vector #207
API/core/view/create_mirror.md create_mirror[_view] #208
API/core/view/deep_copy.md deep_copy() #209
API/core/view/layoutLeft.md LayoutLeft #203
API/core/view/layoutRight.md LayoutRight #204
API/core/view/layoutStride.md LayoutStride #206
API/core/view/realloc.md realloc #211
API/core/view/resize.md resize #226
API/core/initialize_finalize/finalize.md finalize #216
API/core/initialize_finalize/initialize.md initialize #225
API/core/initialize_finalize/InitializationSettings.md InitializationSettings #237
API/core/initialize_finalize/ScopeGuard.md ScopeGuard #236
API/core/execution_spaces.md Execution Spaces #294
API/core/memory_spaces.md Memory Spaces #320
API/core/SpaceAccessibility.md Space Accessibility #249
API/core/parallel-dispatch/fence.md fence() #227
API/core/parallel-dispatch/parallel_for.md parallel_for() #228
API/core/parallel-dispatch/parallel_reduce.md parallel_reduce() #230
API/core/parallel-dispatch/parallel_scan.md parallel_scan() #229
API/core/policies/ExecutionPolicyConcept.md ExecutionPolicy #238
API/core/policies/MDRangePolicy.md MDRangePolicy #241
API/core/policies/NestedPolicies.md NestedPolicies #242
API/core/policies/RangePolicy.md RangePolicy #243
API/core/policies/TeamHandleConcept.md TeamHandleConcept #244
API/core/policies/TeamPolicy.md TeamPolicy #293
API/core/policies/TeamThreadRange.md TeamThreadRange #245
API/core/policies/TeamVectorRange.md TeamVectorRange #247

high priority:

File name Doc title Done with PR
API/containers/DualView.md DualView #285
API/containers/StaticCrsGraph.md StaticCrsGraph #248
API/core/parallel-dispatch/ParallelForTag.md ParallelForTag() #257
API/core/parallel-dispatch/ParallelReduceTag.md ParallelReduceTag() #260
API/core/parallel-dispatch/ParallelScanTag.md ParallelScanTag() #261
API/core/builtinreducers/ReducerConcept.md ReducerConcept #275
API/core/builtinreducers/BAnd.md BAnd #276
API/core/builtinreducers/BOr.md BOr #277
API/core/builtinreducers/LAnd.md LAnd #278
API/core/builtinreducers/LOr.md LOr #279
API/core/builtinreducers/Max.md Max #280
API/core/builtinreducers/MaxLoc.md MaxLoc #281
API/core/builtinreducers/Min.md Min #282
API/core/builtinreducers/MinLoc.md MinLoc #283
API/core/builtinreducers/MinMax.md MinMax #284
API/core/builtinreducers/MinMaxLoc.md MinMaxLoc #271
API/core/builtinreducers/Prod.md Prod #270
API/core/builtinreducers/Sum.md Sum #268
API/core/builtinreducers/MinMaxLocScalar.md MinMaxLocScalar #262
API/core/builtinreducers/MinMaxScalar.md MinMaxScalar #263
API/core/builtinreducers/ValLocScalar.md ValLocScalar #264
API/core/numerics/mathematical-constants.md Mathematical constants #265
API/core/numerics/mathematical-functions.md Common math functions #266
API/core/numerics/numeric-traits.md Numeric traits #267

Medium priority:

File name Doc title Done with PR
API/core/atomics/atomic_compare_exchange.md atomic_compare_exchange #286
API/core/atomics/atomic_compare_exchange_strong.md atomic_compare_exchange_strong #287
API/core/atomics/atomic_exchange.md atomic_exchange #288
API/core/atomics/atomic_fetch_op.md atomic_fetch_[op] #289
API/core/atomics/atomic_load.md atomic_load #301
API/core/atomics/atomic_op.md atomic_[op] #302
API/core/atomics/atomic_op_fetch.md atomic_[op]_fetch #303
API/core/atomics/atomic_store.md atomic_store #304
API/core/c_style_memory_management/free.md kokkos_free #305
API/core/c_style_memory_management/malloc.md kokkos_malloc #306
API/core/c_style_memory_management/realloc.md kokkos_realloc #307
API/core/stl-compat/pair.md Kokkos::pair #308
API/core/utilities/abort.md Kokkos::abort #311
API/core/utilities/complex.md Kokkos::complex #312
API/core/utilities/timer.md Kokkos::Timer #313
API/core/Detection-Idiom.md Detection Idiom #314
API/core/KokkosConcepts.md Kokkos Concepts #317
API/core/Macros.md Macros #322
API/core/Task-Parallelism.md Task-Parallelism #323
API/core/Traits.md Traits #316

Low priority:

File name Doc title Done with PR
API/algorithms/Random-Number.md Random-Number #334
API/algorithms/Sort.md Sort #335
API/algorithms/std-algorithms/Iterators.md Iterators #336
API/algorithms/std-algorithms/StdMinMaxElement.md Minimum/maximum #337
API/algorithms/std-algorithms/StdModSeq.md Modifying Sequence #338
API/algorithms/std-algorithms/StdNonModSeq.md NonModifying Sequence
API/algorithms/std-algorithms/StdNumeric.md Numeric
API/algorithms/std-algorithms/StdPartioningOps.md Partitioning
API/algorithms/std-algorithms/StdSorting.md Sorting

@fnrizzi

This comment was marked as outdated.

Sign in to view
@marcinwrobel1986

This comment was marked as outdated.

Sign in to view
@fnrizzi

This comment was marked as outdated.

Sign in to view
@marcinwrobel1986

This comment was marked as outdated.

Sign in to view
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 26, 2022
kokkos#120: - API/core/view/subview transition from .md to .rst
9f4a9e1
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 26, 2022
kokkos#120: - fixed syntax
8b7f1f9
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 29, 2022
kokkos#120: - API/core/view/view transition from .md to .rst
5c2f1eb
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 29, 2022
kokkos#120: - API/core/view/view_alloc transition from .md to .rst
a8db189
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 29, 2022
kokkos#120: - API/core/view/view_like transition from .md to .rst
7e85651
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Aug 30, 2022
kokkos#120: - API/containers/Bitset transition from .md to .rst
3ccc427
crtrott added a commit that referenced this issue Sep 1, 2022
@crtrott
Merge pull request #148 from marcinwrobel1986/120-API-core-view-view_…
1616b34 
…like

#120: API-core-view-view_like from md to rst
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Sep 2, 2022
kokkos#120: - API/core/view/Bitset applied PR comments
6fec60e
fnrizzi added a commit that referenced this issue Sep 2, 2022
@fnrizzi
Merge pull request #150 from marcinwrobel1986/120-API-containers-Bitset
d8411c7 
#120: API-containers-Bitset from md to rst
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Sep 5, 2022
kokkos#120: - added is_hostspace cpp member
78c1d22 
- redefined `host_mirror_space`
- added spaces
- reorganized view types
- modified `Data Access Functions` (possibly missing param `i`)
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Sep 5, 2022
kokkos#120: - resolved merge conflicts and merge main
7e11329
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 22, 2022
kokkos#120: - convert DynamicView from md to rst
b62613a
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 24, 2022
kokkos#120: - convert DynRankView from md to rst
5ce2586
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 25, 2022
kokkos#120: - convert DynamicView from md to rst
515ed1b
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 27, 2022
kokkos#120: - API containers Offset-View transition from md to rst
c015fc6
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 28, 2022
kokkos#120: - API containers ScatterView transition from md to rst
7dfca9f
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Oct 28, 2022
kokkos#120: - API containers Unordered-Map transition from md to rst
1b0e48d
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Nov 8, 2022
kokkos#120: - API core view LayoutLeft transition from md to rst
e83ede0
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Nov 8, 2022
kokkos#120: - API core view LayoutRight transition from md to rst
1ca2c2d
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Nov 8, 2022
kokkos#120: - API core view LayoutStride transition from md to rst
ba5dfc1
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Nov 9, 2022
kokkos#120: - API containers vector transition from md to rst
5faf234
marcinwrobel1986 pushed a commit to marcinwrobel1986/kokkos-core-wiki that referenced this issue Nov 9, 2022
kokkos#120: - API core view creat_mirror transition from md to rst
8997450
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/containers/DynamicView review done
243a9c1
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: atomic_exchange md to rst
1f613ff
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: atomic_compare_exchange_strong md to rst
4f85246
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: atomic_compare_exchange md to rst
ab3302e
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - API core view realloc transition from md to rst
d4278a3
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/view/realloc review done
c3b4c53
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/view/realloc remove synopsis, fix indentation an…
70c7deb 
…d fix function parameters
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: atomic_fetch_op md to rst
3b6f624
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - API core view LayoutStride transition from md to rst
79682e2
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/view/layoutStride little fix
32da51b
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - API core view creat_mirror transition from md to rst
d2dde8e
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/view/create_mirror little fix
81b0a19
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - API core view LayoutLeft transition from md to rst
ef726f7
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@cz4rs @fnrizzi
kokkos#120: Use cppkokkos extension
0be1263
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/view/layoutLeft review done
7561638
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - API containers Unordered-Map transition from md to rst
dfa32ae
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/containers/Unordered-Map review done
a416731
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@fnrizzi
kokkos#120: - convert DynRankView from md to rst
431937f
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/containers/DynRankView translation in progress
e1efedc
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/containers/DynRankView wip
8e7708c
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/containers/DynRankView finalize
8b85bc7
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: ScopeGuard md to rst using sphinx syntax
872eccb
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/policies/TeamHandleConcept transition from .md t…
49a30c9 
…o .rst init
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/policies/TeamHandleConcept transition from .md t…
88ab573 
…o .rst fix with kokkosinlinefunction
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/policies/TeamHandleConcept fix indents
9685c18
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/policies/TeamHandleConcept fix cppkokkos:function
6ec49e9
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@antoinemeyer5 @fnrizzi
kokkos#120: API/core/policies/TeamHandleConcept feedback fix
1c4dfa4
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: resize md to rst
231362d
fnrizzi pushed a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@pierrepebay @fnrizzi
kokkos#120: fixed alignement
7657107
fnrizzi added a commit to mperrinel/kokkos-core-wiki that referenced this issue Dec 10, 2023
@marcinwrobel1986 @antoinemeyer5 @fnrizzi
API containers ScatterView transition ro rst (kokkos#199)
dd446de 
* kokkos#120: - API containers ScatterView transition from md to rst

* kokkos#120: API/containers/ScatterView review done

* finalize

* fix ordering

---------

Co-authored-by: Marcin Wróbel <marcin.wrobel@ng-analytics.com>
Co-authored-by: antoinemeyer5 <antoine.meyer54@gmail.com>
Co-authored-by: Francesco Rizzi <fnrizzi@sandia.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fnrizzi @marcinwrobel1986