Skip to content

Commit

Permalink
[docu] Updating changelog (fixing typos)
Browse files Browse the repository at this point in the history
  • Loading branch information
sherholz-intel committed Feb 9, 2024
1 parent d70a90b commit bf1ed36
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Version History
## Open PGL 0.6.0

- Api changes:
- `Device` added `numThread` parameter (default = 0) to the constructor to set the number of threads used by `Open PGL` during training. The default value of `0` uses all threads provided by `TBB`. If the renderer uses `TBB` as well and regulates the thread count this count is also used by `Open PGL``.
- `Device` added `numThread` parameter (default = 0) to the constructor to set the number of threads used by `Open PGL` during training. The default value of `0` uses all threads provided by `TBB`. If the renderer uses `TBB` as well and regulates the thread count this count is also used by `Open PGL`.
- `SurfaceSamplingDistribution` and `VolumeSamplingDistribution`:
- Added `GetId` function to return the unique id of the spatial structure used to query the sampling distriubtion.
- `Field` and `SampleStorage`, added `Compare` function to check if the data stored in different instances (e.g., generated by two separate runs) are similar (i.e., same spatial subdivisions and directional distributions).
- `Field`:
- The constructor of the `Field` class now takes a `FieldConfig` instead of a `PGLFieldArguments` object. (BREAKING API CHANGE)
- The constructor of the `Field` class now takes a `FieldConfig` instead of a `PGLFieldArguments` object. **(BREAKING API CHANGE)**
- `GetSurfaceStatistics` and `GetVolumeStatistics` functions are added to query statistics about the surface and volume guiding field. The functions return a `FieldStatistics` object. Note, querying the statistics of a `Field` introduces a small overhead.
- `FieldStatistics`:
- This class store different statistics about a `Field`, such as, number and size of spatial nodes, statistics about the directional distributions, and the times spend for full and separate steps of the last `Update` step. The statistics can be queried as a full string (useful for logging) or as CSV strings (useful for analysis and plotting).
Expand All @@ -20,7 +20,7 @@ Version History
- This class is added to replace the `PGLFieldArguments` struct when using the C++ API.
-`Init`: the function initializes the parameters of the `FieldConfig` (i.e., similar to `pglFieldArgumentsSetDefaults`). Additional parameters (`deterministic` and `maxSamplesPerLeaf`) are introduced to enable deterministic behavior and to control the spatial subdivision granularity.
-`SetSpatialStructureArgMaxDepth`: this function can be called after `Init` to the the maximum tree depth of the spatial structure.
- `pglFieldArgumentsSetDefaults`: Adding two additional parameters `deterministic` and `maxSamplesPerLeaf`. (BREAKING API CHANGE)
- `pglFieldArgumentsSetDefaults`: Adding two additional parameters `deterministic` and `maxSamplesPerLeaf`. **(BREAKING API CHANGE)**

- Tools:
- Added a set of command line tools which are build when enabling the `OPENPGL_BUILD_TOOLS` Cmake flag.
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ specification is still in flux and might change with upcoming releases.
constructor to set the number of threads used by `Open PGL`
during training. The default value of `0` uses all threads
provided by `TBB`. If the renderer uses `TBB` as well and
regulates the thread count this count is also used by \`Open
PGL\`\`.
regulates the thread count this count is also used by
`Open PGL`.
- `SurfaceSamplingDistribution` and `VolumeSamplingDistribution`:
- Added `GetId` function to return the unique id of the
spatial structure used to query the sampling distriubtion.
Expand All @@ -67,7 +67,7 @@ specification is still in flux and might change with upcoming releases.
- `Field`:
- The constructor of the `Field` class now takes a
`FieldConfig` instead of a `PGLFieldArguments` object.
(BREAKING API CHANGE)
**(BREAKING API CHANGE)**
- `GetSurfaceStatistics` and `GetVolumeStatistics` functions
are added to query statistics about the surface and volume
guiding field. The functions return a `FieldStatistics`
Expand Down Expand Up @@ -97,7 +97,8 @@ specification is still in flux and might change with upcoming releases.
called after `Init` to the the maximum tree depth of the
spatial structure.
- `pglFieldArgumentsSetDefaults`: Adding two additional parameters
`deterministic` and `maxSamplesPerLeaf`. (BREAKING API CHANGE)
`deterministic` and `maxSamplesPerLeaf`. **(BREAKING API
CHANGE)**
- Tools:
- Added a set of command line tools which are build when enabling
the `OPENPGL_BUILD_TOOLS` Cmake flag.
Expand Down

0 comments on commit bf1ed36

Please sign in to comment.