Convert external chunking documentation to doxygen #5131
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
byrnHDF
added
Priority - 1. High 🔼
byrnHDF
requested review from
lrknox,
derobins,
fortnern,
jhendersonHDF,
qkoziol,
vchoi-hdfgroup,
bmribler,
glennsong09,
mattjala and
brtnfld
as code owners
lrknox
previously approved these changes
Nov 19, 2024
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * </tr> | ||
| * </table> | ||
| * | ||
| * The HDF5 library treats chunks as atomic objects -- disk I/O is always in terms of complete chunks (Parallel versions |
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * \section sec_hdf5_chunk_issues_data The Raw Data Chunk Cache | ||
| * It's obvious from Figure 2 that calling #H5Dwrite many times from the application would result in poor performance even | ||
| * if the data being written all falls within a single chunk. A raw data chunk cache layer was added between the top of | ||
| * the filter stack and the bottom of the byte modification layer (The raw data chunk cache was added before the second alpha release.). |
There was a problem hiding this comment.
The comment in parens is obsolete and should be removed.
derobins
reviewed
Nov 20, 2024
| * \li A chunk which has just entered the cache is favored. | ||
| * \li A chunk which has been completely read or completely written but not partially read or written is penalized according | ||
| * to some application specified weighting between zero and one. | ||
| * \li A chunk which is larger than the maximum cache size is not eligible for caching. |
There was a problem hiding this comment.
@fortnern - Does this section need revising?
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * </tr> | ||
| * </table> | ||
| * | ||
| * Although the application eventually overwrites every chunk completely the library has know way of knowing this before |
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * </table> | ||
| * | ||
| * Although the application eventually overwrites every chunk completely the library has know way of knowing this before | ||
| * hand since most calls to #H5Dwrite modify only a portion of any given chunk. Therefore, the first modification of a |
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * Although the application eventually overwrites every chunk completely the library has know way of knowing this before | ||
| * hand since most calls to #H5Dwrite modify only a portion of any given chunk. Therefore, the first modification of a | ||
| * chunk will cause the chunk to be read from disk into the chunk buffer through the filter pipeline. Eventually HDF5 might | ||
| * contain a data set transfer property that can turn off this read operation resulting in write efficiency which is equal |
derobins
reviewed
Nov 20, 2024
doxygen/dox/DSChunkingIssues.dox
Outdated
| * | ||
| * Large B-trees have two disadvantages: | ||
| * \li The file storage overhead is higher and more disk I/O is required to traverse the tree from root to leaves. | ||
| * \li The increased number of B-tree nodes will result in higher contention for the meta data cache. |
|
it's nice to move this into the UG. We're going to need to revisit this text in the future, since a lot of it was clearly written before HDF5 1.10 and is a little obsolete. |
derobins
changed the title
derobins
approved these changes
Nov 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.