krish-adi / barfi

Python Flow Based Programming environment that provides a graphical programming environment.
https://barfi.readthedocs.io
MIT License
672 stars 73 forks source link

Need more documentation! #16

Open skycreeds opened 1 year ago

skycreeds commented 1 year ago

Hey @krish-adi , The package was really helpful, I think it will be help full to add more details on classes

I had hard time finding it from code

krish-adi commented 1 year ago

Hey @skycreeds thanks for pointing this out. Could you give me a clear picture of what additional information would be helpful? For the Blocks, Compute Engine, and the Functions?

skycreeds commented 1 year ago

Thanks for reply @krish-adi , functions in Block class especially add_options need a little more details on its parameters like

I think it would also be helpful if there is a detailing on use of computational engine and params of add_editor_state etc.

fbaeumer commented 1 year ago

@krish-adi: It would be helpful for me to get an example how to access the computation results. I can't see any computation results in st.write(barfi_result). It looks like the computation is just not done at all. Of course is set compute_engine=True.

Thank you for your work!

krish-adi commented 1 year ago

Hey @fbaeumer , the computation is done when the execute button is pressed on the streamlit component. Is that the workflow you are also using?

jicastillow commented 1 year ago

Hi @krish-adi. I think the documentation lacks info about Block.add_option feature. Nice work BTW, looking forward for improvements. 👍

KayumovRu commented 9 months ago

Hey @fbaeumer , the computation is done when the execute button is pressed on the streamlit component. Is that the workflow you are also using?

Hi @krish-adi ! Thanks for Barfi! Is it possible to call Execute from Streamlit? For example, to execute a scheme when clicking on the st.button.

krish-adi commented 9 months ago

Oh sure that is possible. Within the context manager, you could use the functions that execute the schema. These functions can be found in the file where the streamlit component is imported from.

KayumovRu commented 9 months ago

UPD: I understood that barfi_result will be suitable for schema_data when compute_engine=False.

@krish-adi: am trying to save the current scheme by a button from Streamlit. I see the manage_schema.save_schema(schema_name, schema_data) function, but I don't understand where to get schema_data? barfi_result is not suitable, since it has a different (simplified) structure. I need a structure like in manage_schema.load_schemas(), but it can only be obtained there after saving. Is there a way to get the current full Barfi schema in Streamlit before saving?