ProtoLife / daptics-api

API documentation and clients for the daptics.ai design of experiments engine
https://daptics.ai
GNU General Public License v3.0
1 stars 1 forks source link

Document explicitly which functions create tasks #17

Closed pzingg closed 4 years ago

pzingg commented 4 years ago

Regardless of option settings, these two methods will create long-running tasks that must be polled or waited on.

  1. put_experimental_parameters (or its csv variant) creates a "space" task
  2. generate_design creates a "generate" task

But if the auto_generate_next_design option is set and there are any remaining generations to be designed in the session, then put_experiments (or its csv variant) will automatically start a "generate" task after it has uploaded the experiments to the server. The task information will then be available in the "task" attribute of the result.

pzingg commented 4 years ago

The documentation in daptics_client.py in PR #22 is now correct. Need to bring the notebooks' documentation to be in line with the client's.

pzingg commented 4 years ago

Better documentation in v0.9.2 with auto_ options.