Allow users to control iteration via the concept of iteration spaces. #80

robertmaynard · 2022-02-25T20:10:16Z

Changes in the work include:

Internally use linear_space for iterating
Simplify type and value iteration in state_iterator::build_axis_configs
Store the iteration space in axes_metadata
Expose zip and user spaces to user
Add tests for linear, zip, and user
Add examples for zip and user

Fixes #68

Changes in the work include: - [x] Internally use linear_space for iterating - [x] Simplify type and value iteration in `state_iterator::build_axis_configs` - [x] Store the iteration space in `axes_metadata` - [x] Expose `tie` and `user` spaces to user - [x] Add tests for `linear`, `tie`, and `user` - [x] Add examples for `tie` and `user`

docs/benchmarks.md

examples/custom_iteration_spaces.cu

jrhemstad

re: naming, I'd stick with zip as opposed to tie.

I think "zip" is more intuitive and descriptive based on the precedence of things like thrust::zip_iterator and std::ranges::zip_view.

jrhemstad · 2022-02-28T16:31:43Z

nvbench/axis_iteration_space.cuh

+  virtual std::unique_ptr<axis_space_base> do_clone() const         = 0;
+  virtual detail::axis_space_iterator do_iter(axes_info info) const = 0;
+  virtual std::size_t do_size(const axes_info &info) const          = 0;
+  virtual std::size_t do_valid_count(const axes_info &info) const   = 0;


It'd be nice to get some docs on the concept of a "axis space" as well as the semantics of these functions.

Agreed, same for the linear_axis_space and other subclasses below.

I have added more documentation

docs/benchmarks.md

alliepiper

Did an initial round of review, but didn't finish -- sharing my comments so far. Will give this a closer look later.

In the meantime, can you go through this and add documentation for the new interfaces?

Having a high-level overview of how these pieces fit together would also be helpful, maybe include that in the class docs for nvbench::detail::axes_iterator.

docs/benchmarks.md

nvbench/benchmark_base.cuh

docs/benchmarks.md

nvbench/axis_iteration_space.cuh

nvbench/axis_iteration_space.cxx

nvbench/axis_iteration_space.cuh

nvbench/axis_iteration_space.cxx

Co-authored-by: Allison Vacanti <[email protected]>

docs/benchmarks.md

jrhemstad · 2022-08-23T16:21:51Z

nvbench/iteration_space_base.cuh

+   * Construct a new derived iteration_space
+   *
+   * @param[input_indices]
+   * @param[output_indices]
+   */
+  iteration_space_base(std::vector<std::size_t> input_indices,
+                       std::vector<std::size_t> output_indices);


It's not obvious what the input_indices/output_indices represent here and could use docs to explain.

I have updated the docs with more information, does that help clarify it?

nvbench/axes_metadata.cxx

Co-authored-by: Jake Hemstad <[email protected]>

jrhemstad · 2022-08-30T23:19:21Z

nvbench/iteration_space_base.cuh

+   * The input_indices and output_indices combine together to allow the iteration space to know
+   * what axi they should query from axes_metadata and where each of those map to in the output
+   * iteration space.


So input_indices determines which elements from the std::vector<std::unique_ptr<nvbench::axis_base>> inside axes_metadata are referenced by the iteration_space?

What do the output_indices reference?

So input_indices determines which elements from the std::vector<std::unique_ptrnvbench::axis_base> inside axes_metadata are referenced by the iteration_space?

Correct.

What do the output_indices reference?

The location in the detail::state_iterator vector of results for a given entry in the cross produce of both type and value axis

It has been awhile since I wrote this class, and with the removal of adding abitrary zips the output_indices might be unneeded if we have the number of type axis. I will see if I can refactor.

I have updated the PR and was able to both remove output_indices and simplify the interator update logic.

nvbench/linear_axis_space.cxx

jrhemstad · 2022-08-30T23:28:45Z

nvbench/detail/axes_iterator.cuh

+  std::size_t active_size;
+};
+
+struct axis_space_iterator


Given this is a pretty central piece of new machinery, this could use some docs for what is going on here.

Also, given this isn't really an iterator in the sense that it doesn't satisfy any std::iterator concepts, I think the iterator name is confusing (it confused me anyways).

I'd either make it satisfy an appropriate iterator concept or give it a different name.

The class matches the naming pattern of the existing state_iterator ( https://github.com/NVIDIA/nvbench/blob/main/nvbench/detail/state_generator.cuh#L74 ) which calls the axis_iterator.

nvbench/detail/axes_iterator.cuh

jrhemstad · 2022-08-30T23:40:32Z

nvbench/user_axis_space.cuh

+ *                                  std::move(output_indices))
+ *   {}
+ *
+ *   nvbench::detail::axis_space_iterator do_get_iterator(axes_info info) const


Having things in the detail namespace appear in something called user_axis_space seems incongruous.

I have updated the implementation around here, so it would be good to review again. If we are happy with axis_space_iterator I will promote it to nvbench::

bdice · 2024-08-07T21:23:05Z

Can we revive this PR? Are there blockers?

jrhemstad reviewed Feb 26, 2022

View reviewed changes

docs/benchmarks.md Outdated Show resolved Hide resolved

jrhemstad reviewed Feb 26, 2022

View reviewed changes

examples/custom_iteration_spaces.cu Outdated Show resolved Hide resolved

jrhemstad reviewed Feb 28, 2022

View reviewed changes

docs/benchmarks.md Outdated Show resolved Hide resolved

Rename tie_axes to zip_axes

a25f578

robertmaynard force-pushed the fea/axes_iteration_space branch from 182f1da to a25f578 Compare February 28, 2022 19:23

implement easier API to add axis and zip/user iteration at the same time

c3c86e1

robertmaynard force-pushed the fea/axes_iteration_space branch from 0a2130f to c3c86e1 Compare February 28, 2022 21:44

Show zip versus linear iteration

91c8f43

jrhemstad reviewed Mar 1, 2022

View reviewed changes

docs/benchmarks.md Outdated Show resolved Hide resolved

PointKernel mentioned this pull request Mar 22, 2022

Erase Functionality for static_map NVIDIA/cuCollections#142

Merged

alliepiper reviewed Apr 11, 2022

View reviewed changes

robertmaynard and others added 11 commits April 12, 2022 09:46

Update docs/benchmarks.md

f4570d4

Co-authored-by: Allison Vacanti <[email protected]>

Update docs/benchmarks.md

f791475

Co-authored-by: Allison Vacanti <[email protected]>

Update nvbench/axis_iteration_space.cxx

f50a6dd

Co-authored-by: Allison Vacanti <[email protected]>

Update nvbench/axis_iteration_space.cuh

796f7f7

Co-authored-by: Allison Vacanti <[email protected]>

Update nvbench/axis_iteration_space.cxx

edba477

Co-authored-by: Allison Vacanti <[email protected]>

Update examples/custom_iteration_spaces.cu

9337ba9

Co-authored-by: Allison Vacanti <[email protected]>

Update examples/custom_iteration_spaces.cu

a02d648

Co-authored-by: Allison Vacanti <[email protected]>

Update examples/custom_iteration_spaces.cu

e80392e

Co-authored-by: Allison Vacanti <[email protected]>

Update examples/custom_iteration_spaces.cu

4c964d2

Co-authored-by: Allison Vacanti <[email protected]>

More cleanup

26467f3

More cleanup

5b000e8

robertmaynard force-pushed the fea/axes_iteration_space branch 3 times, most recently from 5dc6c83 to d8d80e4 Compare April 12, 2022 16:22

Refactor names

ba8356f

robertmaynard force-pushed the fea/axes_iteration_space branch from d8d80e4 to ba8356f Compare April 12, 2022 16:35

robertmaynard force-pushed the fea/axes_iteration_space branch from f66cca3 to f4396bd Compare April 12, 2022 17:47

Refactor axis spaces into separate TUs

e7b4800

robertmaynard force-pushed the fea/axes_iteration_space branch from f4396bd to e7b4800 Compare April 13, 2022 19:26

robertmaynard added 4 commits April 13, 2022 17:17

Add iteration_space_base docs

9aa2feb

rename files holding iteration_space_base to match name of class

06a4c8f

Add more docs

454d1bf

Add more docs

8af9453

jrhemstad reviewed Aug 23, 2022

View reviewed changes

docs/benchmarks.md Outdated Show resolved Hide resolved

jrhemstad reviewed Aug 23, 2022

View reviewed changes

docs/benchmarks.md Outdated Show resolved Hide resolved

jrhemstad reviewed Aug 23, 2022

View reviewed changes

nvbench/axes_metadata.cxx Outdated Show resolved Hide resolved

robertmaynard and others added 4 commits August 23, 2022 14:34

drop usage of std::tie in nvbench/axes_metadata.cxx

6fd0883

Co-authored-by: Jake Hemstad <[email protected]>

Update to cross reference docs

99395df

Update docs around iteration_space_base constructor

5ebe7fe

Drop ability to zip axii after construction

dc7e2b7

robertmaynard requested a review from jrhemstad August 29, 2022 14:26

jrhemstad reviewed Aug 30, 2022

View reviewed changes

nvbench/linear_axis_space.cxx Outdated Show resolved Hide resolved

jrhemstad reviewed Aug 30, 2022

View reviewed changes

nvbench/detail/axes_iterator.cuh Outdated Show resolved Hide resolved

jrhemstad reviewed Aug 30, 2022

View reviewed changes

nvbench/detail/axes_iterator.cuh Outdated Show resolved Hide resolved

jrhemstad reviewed Aug 30, 2022

View reviewed changes

robertmaynard force-pushed the fea/axes_iteration_space branch from 0ade18a to 282754b Compare August 31, 2022 15:08

remove need for make_space_iterator

5708e6c

robertmaynard force-pushed the fea/axes_iteration_space branch from 282754b to 5708e6c Compare August 31, 2022 15:08

robertmaynard added 3 commits August 31, 2022 11:13

update axis_space_iterator to use same method names as state_iterator

3ad3d65

remove need for output_indices

c2bfc99

Simplified user iterators

910b5cc

PointKernel mentioned this pull request Aug 7, 2024

Add keep option to distinct nvbench rapidsai/cudf#16497

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow users to control iteration via the concept of iteration spaces. #80

Allow users to control iteration via the concept of iteration spaces. #80

robertmaynard commented Feb 25, 2022 •

edited

Loading

jrhemstad left a comment

jrhemstad Feb 28, 2022

alliepiper Apr 11, 2022

robertmaynard May 2, 2022

alliepiper left a comment •

edited

Loading

jrhemstad Aug 23, 2022 •

edited

Loading

robertmaynard Aug 23, 2022

jrhemstad Aug 30, 2022

robertmaynard Aug 31, 2022

robertmaynard Sep 1, 2022

robertmaynard Sep 1, 2022

jrhemstad Aug 30, 2022

jrhemstad Aug 30, 2022

robertmaynard Aug 31, 2022

jrhemstad Aug 30, 2022

robertmaynard Sep 1, 2022

bdice commented Aug 7, 2024

Allow users to control iteration via the concept of iteration spaces. #80

Are you sure you want to change the base?

Allow users to control iteration via the concept of iteration spaces. #80

Conversation

robertmaynard commented Feb 25, 2022 • edited Loading

jrhemstad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alliepiper left a comment • edited Loading

Choose a reason for hiding this comment

jrhemstad Aug 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdice commented Aug 7, 2024

robertmaynard commented Feb 25, 2022 •

edited

Loading

alliepiper left a comment •

edited

Loading

jrhemstad Aug 23, 2022 •

edited

Loading