Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need more documentation! #16

Open
skycreeds opened this issue Apr 7, 2023 · 8 comments
Open

Need more documentation! #16

skycreeds opened this issue Apr 7, 2023 · 8 comments

Comments

@skycreeds
Copy link

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

@krish-adi
Copy link
Owner

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
Copy link
Author

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.

@fbaeumer
Copy link

fbaeumer commented Jun 4, 2023

@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
Copy link
Owner

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
Copy link

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

@KayumovRu
Copy link

KayumovRu commented Feb 11, 2024

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
Copy link
Owner

krish-adi commented Feb 11, 2024

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
Copy link

KayumovRu commented Feb 11, 2024

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?

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

No branches or pull requests

5 participants