Add Streamlit Chat Migration Guide

[MarcSkovMadsen]

Builds on top of #5633.

This PR adds a Streamlit Chat Migration Guide. It will

• Make the Streamlit Migration Guide more complete
• Benchmark our chat components against Streamlits
• Provide the StreamlitConverter app example some context about conversational chat apps. See Streamlit App Converter holoviz-topics/panel-chat-examples#61.

Preview the guide here

FYI. @ahuang11

Questions

• Should we rename ChatEntry to ChatMessage. Both Streamlit and LangChain use the term message. For example st.chat_message. The ChatEntry name could also mistakingly be interpreted as a chat_input like component?
• Should we provide a ChatInput component similar to Streamlits chat_input?
• Should we provide a Status component similar to Streamlits status?

Todo:

• Merge with main and rename ChatEntry to ChatMessage. Rename ChatMessage.value to .object and ChatFeed.value to .objects.
• Philipp should upload the assets and replace the links.

[codecov]

Codecov Report

Merging #5642 (872b744) into main (db1e9fe) will decrease coverage by 0.05%.
Report is 2 commits behind head on main.
The diff coverage is 91.23%.

@@            Coverage Diff             @@
##             main    #5642      +/-   ##
==========================================
- Coverage   83.65%   83.61%   -0.05%     
==========================================
  Files         280      288       +8     
  Lines       41580    41678      +98     
==========================================
+ Hits        34782    34847      +65     
- Misses       6798     6831      +33     

Flag	Coverage Δ
ui-tests	39.63% <28.09%> (+0.05%)	⬆️
unitexamples-tests	73.72% <91.23%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
panel/__init__.py	100.00% <100.00%> (ø)
panel/chat/__init__.py	100.00% <100.00%> (ø)
panel/tests/chat/test_entry.py	100.00% <100.00%> (ø)
panel/tests/chat/test_feed.py	100.00% <100.00%> (ø)
panel/tests/chat/test_icon.py	100.00% <100.00%> (ø)
panel/tests/chat/test_interface.py	100.00% <100.00%> (ø)
panel/widgets/__init__.py	100.00% <ø> (ø)
panel/chat/icon.py	92.64% <92.64%> (ø)
panel/chat/interface.py	95.45% <95.45%> (ø)
panel/chat/feed.py	95.06% <95.06%> (ø)
... and 3 more

... and 4 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[MarcSkovMadsen]

Should we add a component like this to Panels chat components @ahuang11 and @philippjfr ?

[MarcSkovMadsen]

This custom Viewer component also shows some of the challenges it has.

• The component is not and cannot be used as a widget. I.e. you need to pn.bind to and pn.depends on chat_input.param.value not chat_input. There is no .from_param method etc.
• It takes a lot of boiler plate code to separate the viewer params from the _layout params. And getting sizing_mode, width, ... properly linked up to the _layout is almost impossible.

I.e. you can make custom components using Viewer. But I can't see how you can create something that Panel would be willing to include as a proper widget without really a lot of code.

[MarcSkovMadsen]

Asset for upload

[MarcSkovMadsen]

Should we add a Status component like this to Panel?

If yes, we should consider How we want to show this status if we have not yet started a run. Should it be disabled, not visible or have some custom look?

The current implementation accepts str steps only. That is probably not what we want if we add it to Panel. It should probably accept as a minimum Markdown and at best any Panel component.

The steps should probably not be constant.

[MarcSkovMadsen]

Maybe object and objects would be more in line with Panels naming convention than step and steps?

[MarcSkovMadsen]

I will be on holiday for the next 3 days. I believe what is here is self contained and ready to include if you decide to release the Chat components within the next 3 days.

I plan to add more examples like CallbackHandler when I get back from holiday.

[philippjfr]

Superseded by #5670

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.