arkouda.comm_diagnostics¶

Functions¶

`get_comm_diagnostics`(→ arkouda.dataframe.DataFrame)	Return a DataFrame with the communication diagnostics statistics.
`get_comm_diagnostics_amo`()	atomic memory operations
`get_comm_diagnostics_cache_get_hits`()	GETs that were handled by the cache.
`get_comm_diagnostics_cache_get_misses`()	GETs that were not handled by the cache
`get_comm_diagnostics_cache_num_page_readaheads`()	Number of readaheads issued to the remote cache at the granularity of cache pages.
`get_comm_diagnostics_cache_num_prefetches`()	Number of prefetches issued to the remote cache at the granularity of cache pages.
`get_comm_diagnostics_cache_prefetch_unused`()	Number of cache pages that were prefetched but evicted from the cache before being accessed
`get_comm_diagnostics_cache_prefetch_waited`()	Number of cache pages that were prefetched but did not arrive in the cache before being accessed
`get_comm_diagnostics_cache_put_hits`()	PUTs that were stored in cache pages that already existed.
`get_comm_diagnostics_cache_put_misses`()	PUTs that required the cache to create a new page to store them.
`get_comm_diagnostics_cache_readahead_unused`()	Number of cache pages that were read ahead but evicted from the cache before being accessed
`get_comm_diagnostics_cache_readahead_waited`()	Number of cache pages that were read ahead but did not arrive in the cache before being accessed
`get_comm_diagnostics_execute_on`()	blocking remote executions, in which initiator waits for completion
`get_comm_diagnostics_execute_on_fast`()	blocking remote executions performed by the target locale’s Active Message handler
`get_comm_diagnostics_execute_on_nb`()	non-blocking remote executions
`get_comm_diagnostics_get`()	blocking GETs, in which initiator waits for completion
`get_comm_diagnostics_get_nb`()	non-blocking GETs
`get_comm_diagnostics_put`()	blocking PUTs, in which initiator waits for completion
`get_comm_diagnostics_put_nb`()	non-blocking PUTs
`get_comm_diagnostics_try_nb`()	tests for non-blocking GET/PUT completions
`get_comm_diagnostics_wait_nb`()	blocking waits for non-blocking GET/PUT completions
`print_comm_diagnostics_table`([print_empty_columns])	Print the current communication counts in a markdown table
`reset_comm_diagnostics`()	Reset aggregate communication counts across the whole program.
`start_comm_diagnostics`()	Start counting communication operations across the whole program.
`start_verbose_comm`()	Start on-the-fly reporting of communication initiated on any locale.
`stop_comm_diagnostics`()	Stop counting communication operations across the whole program.
`stop_verbose_comm`()	Stop on-the-fly reporting of communication initiated on any locale.

Module Contents¶

arkouda.comm_diagnostics.get_comm_diagnostics() → arkouda.dataframe.DataFrame[source]¶

Return a DataFrame with the communication diagnostics statistics.

Return type:: DataFrame

arkouda.comm_diagnostics.get_comm_diagnostics_amo()[source]¶

atomic memory operations

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_get_hits()[source]¶

GETs that were handled by the cache. GETs counted here did not require the cache to communicate in order to return the result.

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_get_misses()[source]¶

GETs that were not handled by the cache

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_num_page_readaheads()[source]¶

Number of readaheads issued to the remote cache at the granularity of cache pages.

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_num_prefetches()[source]¶

Number of prefetches issued to the remote cache at the granularity of cache pages. This counter is specifically triggered via calls to chpl_comm_remote_prefetch

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_prefetch_unused()[source]¶

Number of cache pages that were prefetched but evicted from the cache before being accessed (i.e., the prefetches were too early).

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_prefetch_waited()[source]¶

Number of cache pages that were prefetched but did not arrive in the cache before being accessed (i.e., the prefetches were too late).

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_put_hits()[source]¶

PUTs that were stored in cache pages that already existed.

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_put_misses()[source]¶

PUTs that required the cache to create a new page to store them.

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_readahead_unused()[source]¶

Number of cache pages that were read ahead but evicted from the cache before being accessed (i.e., the readaheads were too early).

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_cache_readahead_waited()[source]¶

Number of cache pages that were read ahead but did not arrive in the cache before being accessed (i.e., the readaheads were too late).

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_execute_on()[source]¶

blocking remote executions, in which initiator waits for completion

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_execute_on_fast()[source]¶

blocking remote executions performed by the target locale’s Active Message handler

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_execute_on_nb()[source]¶

non-blocking remote executions

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_get()[source]¶

blocking GETs, in which initiator waits for completion

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_get_nb()[source]¶

non-blocking GETs

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_put()[source]¶

blocking PUTs, in which initiator waits for completion

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_put_nb()[source]¶

non-blocking PUTs

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_try_nb()[source]¶

tests for non-blocking GET/PUT completions

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.get_comm_diagnostics_wait_nb()[source]¶

blocking waits for non-blocking GET/PUT completions

Returns:: A pdarray, where the size is the number of locales, populated with the statistic value from each locale.
Return type:: pdarray

arkouda.comm_diagnostics.print_comm_diagnostics_table(print_empty_columns=False)[source]¶

Print the current communication counts in a markdown table using a row per locale and a column per operation. By default, operations for which all locales have a count of zero are not displayed in the table, though an argument can be used to reverse that behavior.

Parameters:: print_empty_columns (bool=False)

Note

The table will only be printed to the chapel logs.

Returns:: Completion message.
Return type:: str

arkouda.comm_diagnostics.reset_comm_diagnostics()[source]¶

Reset aggregate communication counts across the whole program.

Returns:: Completion message.
Return type:: str

arkouda.comm_diagnostics.start_comm_diagnostics()[source]¶

Start counting communication operations across the whole program.

Returns:: Completion message.
Return type:: str

arkouda.comm_diagnostics.start_verbose_comm()[source]¶

Start on-the-fly reporting of communication initiated on any locale.

Note

Reporting will only be printed to the chapel logs.

Returns:: Completion message.
Return type:: str

arkouda.comm_diagnostics.stop_comm_diagnostics()[source]¶

Stop counting communication operations across the whole program.

Returns:: Completion message.
Return type:: str

arkouda.comm_diagnostics.stop_verbose_comm()[source]¶

Stop on-the-fly reporting of communication initiated on any locale.

Returns:: Completion message.
Return type:: str