Skip to content

docs: refine pynumaflow README#351

Open
kohlisid wants to merge 3 commits intomainfrom
rd
Open

docs: refine pynumaflow README#351
kohlisid wants to merge 3 commits intomainfrom
rd

Conversation

@kohlisid
Copy link
Copy Markdown
Contributor

@kohlisid kohlisid commented Apr 9, 2026

Kindly explain what this PR does.

kohlisid added 2 commits April 8, 2026 19:51
Signed-off-by: kohlisid <sidhant.kohli@gmail.com>
Signed-off-by: kohlisid <sidhant.kohli@gmail.com>
@kohlisid kohlisid marked this pull request as ready for review April 9, 2026 03:19
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.65%. Comparing base (5830a34) to head (98fca4f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #351   +/-   ##
=======================================
  Coverage   92.65%   92.65%           
=======================================
  Files          67       67           
  Lines        3514     3514           
  Branches      229      229           
=======================================
  Hits         3256     3256           
  Misses        193      193           
  Partials       65       65           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines +77 to +88
| Functionality | Server Class(es) |
|---|---|
| [**UDSource**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/source) | [SourceAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/source/simple_source/example.py) |
| [**UDSink**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/sink) | [SinkServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/sink/log/example.py), [SinkAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/sink/async_log/example.py) |
| [**Side Input**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/sideinput) | [SideInputServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/sideinput/simple_sideinput/example.py) |
| [**Map**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/map) | [MapServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/map/even_odd/example.py), [MapAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/map/async_forward_message/example.py), [MapMultiprocServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/map/multiproc_map/example.py) |
| [**Reduce**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/reduce) | [ReduceAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/reduce/counter/example.py) |
| [**Reduce Stream**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/reducestream) | [ReduceStreamAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/reducestream/counter/example.py) |
| [**Map Stream**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/mapstream) | [MapStreamAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/mapstream/flatmap_stream/example.py) |
| [**Batch Map**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/batchmap) | [BatchMapAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/batchmap/flatmap/example.py) |
| [**Accumulator**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/accumulator) | [AccumulatorAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/accumulator/streamsorter/example.py) |
| [**Source Transform**](https://github.com/numaproj/numaflow-python/tree/main/packages/pynumaflow/examples/sourcetransform) | [SourceTransformServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/sourcetransform/event_time_filter/example.py), [SourceTransformAsyncServer](https://github.com/numaproj/numaflow-python/blob/main/packages/pynumaflow/examples/sourcetransform/async_event_time_filter/example.py), SourceTransformMultiProcServer |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer to keep the table and point to the modules under the api? Or remove altogether

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep the table and point to API? @BulkBeing any thoughts?

Comment on lines +72 to +73
> [!IMPORTANT]
> MultiProcess forks N independent gRPC servers within the same container. The `server_count` parameter is required: `MapMultiprocServer(handler, server_count=2)`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Multiprocess does not work, so we can ignore this callout? Details - numaproj/numaflow#2903 (comment)

Copy link
Copy Markdown
Contributor Author

@kohlisid kohlisid Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah! Actually, I wanted to incorporate that detail as well.

As we aren't deprecating it, should we rather callout that currently multiproc works only with golang dataplane. Or we do not want to endorse that completely?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's remove it from the doc because we do not know when we are going to support. Golang dataplane is EOL :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on removing all references for now then!

Signed-off-by: kohlisid <sidhant.kohli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants