flow-php / flow

Flow PHP - data processing framework
https://flow-php.com
MIT License
491 stars 28 forks source link

Display DSL function usage examples at function doc page #1215

Closed norberttech closed 2 months ago

norberttech commented 2 months ago

Change Log

Added

  • Display DSL function usage examples at function doc page
  • More DataFrame usage examples
  • Priority parameter that defines in what order examples/topics are displayed
  • Hidden parameter that allows to not display specific examples/topics but still let dsl docs link to them

Fixed

Changed

  • Improved title/description at DSL documentation pages

Removed

Deprecated

Security


Description

image
github-actions[bot] commented 2 months ago

Flow PHP - Benchmarks

Results of the benchmarks from this PR are compared with the results from 1.x branch.

Extractors ```shell +-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+ | benchmark | subject | revs | its | mem_peak | mode | rstdev | +-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+ | CSVExtractorBench | bench_extract_10k | 1 | 3 | 4.533mb +0.15% | 517.668ms +1.57% | ±0.91% +558.27% | | JsonExtractorBench | bench_extract_10k | 1 | 3 | 4.647mb +0.14% | 1.063s -0.90% | ±0.16% -79.69% | | ParquetExtractorBench | bench_extract_10k | 1 | 3 | 29.104mb +0.02% | 434.657ms +0.41% | ±1.11% +446.58% | | TextExtractorBench | bench_extract_10k | 1 | 3 | 4.290mb +0.16% | 33.288ms -3.64% | ±0.14% -94.20% | | XmlExtractorBench | bench_extract_10k | 1 | 3 | 4.280mb +0.16% | 764.887ms +1.58% | ±3.26% +121.25% | +-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+ ```
Transformers ```shell +-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+ | benchmark | subject | revs | its | mem_peak | mode | rstdev | +-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+ | RenameEntryTransformerBench | bench_transform_10k_rows | 1 | 3 | 116.566mb +0.01% | 59.775ms -0.99% | ±1.50% +36.62% | +-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+ ```
Loaders ```shell +--------------------+----------------+------+-----+------------------+------------------+----------------+ | benchmark | subject | revs | its | mem_peak | mode | rstdev | +--------------------+----------------+------+-----+------------------+------------------+----------------+ | CSVLoaderBench | bench_load_10k | 1 | 3 | 54.731mb +0.01% | 140.177ms +0.55% | ±0.60% -0.00% | | JsonLoaderBench | bench_load_10k | 1 | 3 | 90.340mb +0.01% | 116.679ms -0.23% | ±0.31% -76.62% | | ParquetLoaderBench | bench_load_10k | 1 | 3 | 124.459mb +0.01% | 1.235s +0.31% | ±0.13% -94.48% | | TextLoaderBench | bench_load_10k | 1 | 3 | 17.481mb +0.04% | 44.096ms -1.34% | ±0.37% -52.72% | +--------------------+----------------+------+-----+------------------+------------------+----------------+ ```
Building Blocks ```shell +-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+ | benchmark | subject | revs | its | mem_peak | mode | rstdev | +-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+ | NativeEntryFactoryBench | bench_entry_factory | 1 | 3 | 107.409mb +0.01% | 474.682ms +0.92% | ±0.34% -81.64% | | NativeEntryFactoryBench | bench_entry_factory | 1 | 3 | 55.767mb +0.01% | 236.560ms -0.90% | ±1.18% +125.90% | | NativeEntryFactoryBench | bench_entry_factory | 1 | 3 | 14.605mb +0.05% | 52.330ms +0.90% | ±0.64% -78.81% | | RowsBench | bench_chunk_10_on_10k | 2 | 3 | 87.322mb +0.01% | 3.650ms +2.80% | ±1.94% -27.00% | | RowsBench | bench_diff_left_1k_on_10k | 2 | 3 | 102.926mb +0.01% | 187.695ms +0.45% | ±0.23% +12.48% | | RowsBench | bench_diff_right_1k_on_10k | 2 | 3 | 85.646mb +0.01% | 18.648ms -1.66% | ±0.16% -93.95% | | RowsBench | bench_drop_1k_on_10k | 2 | 3 | 88.562mb +0.01% | 1.838ms +3.47% | ±1.71% -53.37% | | RowsBench | bench_drop_right_1k_on_10k | 2 | 3 | 88.562mb +0.01% | 1.951ms +6.51% | ±1.89% -13.88% | | RowsBench | bench_entries_on_10k | 2 | 3 | 85.674mb +0.01% | 2.926ms -4.20% | ±2.16% +19.00% | | RowsBench | bench_filter_on_10k | 2 | 3 | 86.203mb +0.01% | 16.453ms +0.29% | ±1.38% +49.44% | | RowsBench | bench_find_on_10k | 2 | 3 | 86.203mb +0.01% | 16.383ms -2.25% | ±0.37% -60.92% | | RowsBench | bench_find_one_on_10k | 10 | 3 | 84.107mb +0.01% | 1.706μs -5.22% | ±2.72% +0.00% | | RowsBench | bench_first_on_10k | 10 | 3 | 84.107mb +0.01% | 0.400μs 0.00% | ±0.00% 0.00% | | RowsBench | bench_flat_map_on_1k | 2 | 3 | 93.457mb +0.01% | 12.625ms -0.32% | ±2.90% +119.99% | | RowsBench | bench_map_on_10k | 2 | 3 | 122.828mb +0.01% | 61.457ms +2.33% | ±0.38% -40.34% | | RowsBench | bench_merge_1k_on_10k | 2 | 3 | 86.723mb +0.01% | 1.709ms +1.09% | ±2.42% +11.07% | | RowsBench | bench_partition_by_on_10k | 2 | 3 | 90.079mb +0.01% | 58.664ms -1.66% | ±0.24% -47.17% | | RowsBench | bench_remove_on_10k | 2 | 3 | 88.824mb +0.01% | 4.621ms +1.34% | ±2.67% +61.12% | | RowsBench | bench_sort_asc_on_1k | 2 | 3 | 84.257mb +0.01% | 41.273ms +4.38% | ±1.88% +172.71% | | RowsBench | bench_sort_by_on_1k | 2 | 3 | 84.257mb +0.01% | 40.421ms +2.82% | ±0.91% +3.28% | | RowsBench | bench_sort_desc_on_1k | 2 | 3 | 84.257mb +0.01% | 40.621ms -0.09% | ±1.46% -20.08% | | RowsBench | bench_sort_entries_on_1k | 2 | 3 | 86.548mb +0.01% | 7.385ms -0.57% | ±0.58% -24.26% | | RowsBench | bench_sort_on_1k | 2 | 3 | 84.107mb +0.01% | 28.272ms -4.66% | ±0.46% -53.28% | | RowsBench | bench_take_1k_on_10k | 10 | 3 | 84.107mb +0.01% | 13.783μs +0.03% | ±1.55% +72.37% | | RowsBench | bench_take_right_1k_on_10k | 10 | 3 | 84.107mb +0.01% | 16.558μs +1.22% | ±1.76% -1.20% | | RowsBench | bench_unique_on_1k | 2 | 3 | 102.927mb +0.01% | 191.277ms -1.25% | ±0.70% +138.18% | | TypeDetectorBench | bench_type_detector | 1 | 3 | 53.212mb +0.01% | 386.595ms -1.09% | ±0.22% -92.97% | | TypeDetectorBench | bench_type_detector | 1 | 3 | 13.478mb +0.05% | 79.503ms -0.30% | ±1.02% -20.89% | +-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+ ```