barfi icon indicating copy to clipboard operation
barfi copied to clipboard

Need more documentation!

Open skycreeds opened this issue 1 year ago • 8 comments

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

  • Blocks
  • Computation engine and also about functions and its parameters

I had hard time finding it from code

skycreeds avatar Apr 07 '23 05:04 skycreeds

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?

krish-adi avatar Apr 07 '23 08:04 krish-adi

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

  • types
  • items(when using type=select)
  • value and also how to use these params for different types

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

skycreeds avatar Apr 13 '23 06:04 skycreeds

@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!

fbaeumer avatar Jun 04 '23 18:06 fbaeumer

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

krish-adi avatar Jun 11 '23 10:06 krish-adi

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

jicastillow avatar Nov 03 '23 11:11 jicastillow

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.

KayumovRu avatar Feb 11 '24 12:02 KayumovRu

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.

krish-adi avatar Feb 11 '24 12:02 krish-adi

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?

KayumovRu avatar Feb 11 '24 14:02 KayumovRu