Add documentation for exposing submission API #793
Conversation
toan-quach
requested review from
FabienLelaquais and
jrobinAV
and removed request for
FabienLelaquais
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
jrobinAV
changed the title
| tp.Core().run() | ||
|
|
||
| scenario = tp.create_scenario(my_config.monthly_scenario_cfg) | ||
|
|
||
| tp.submit(scenario) | ||
|
|
||
| tp.Core().run() |
There was a problem hiding this comment.
Why changing that? It is the opposite of what is described above.
There was a problem hiding this comment.
In the doc above: "Note that jobs can only be executed after the Taipy Core service is started." => The tp.Core().run() must be run first before we submit the scenario, the previous code was incorrect in that sense, no?
There was a problem hiding this comment.
Not really. The Core service can be run before or after submitting jobs.
But the execution starts only when the service is started.
These lines are here to show how to submit jobs before running the service.
| tp.Core().run() | ||
|
|
||
| scenario = tp.create_scenario(scenario_config) | ||
| tp.submit(scenario) | ||
|
|
||
| # Retrieve all submission. | ||
| print(f'(2) Number of submissions: {len(tp.get_submissions())}.') | ||
|
|
||
| # Get the latest created submission of the scenario. | ||
| tp.get_latest_submission(scenario) | ||
|
|
||
| # Then delete it. | ||
| tp.delete(submission) | ||
| print(f'(3) Number of submissions: {len(tp.get_submissions())}.') |
There was a problem hiding this comment.
Can we set this under a
if __name__ == "__main__":
There was a problem hiding this comment.
I think we can but I don't think it's the convention in taipy-doc?
There was a problem hiding this comment.
No it is not. But I am thinking of adding it, actually.
What do you think?
There was a problem hiding this comment.
haha it makes sense to! But in that case, then change should be applied to everywhere in the doc for consistency. Should we keep it in a separate PR?
| scenario = tp.create_scenario(my_config.monthly_scenario_cfg) | ||
| task = scenario.predicting | ||
|
|
||
| job = tp.submit(task) | ||
| submission = tp.submit(task) |
There was a problem hiding this comment.
Can we add
if __name__ == "__main__":
Co-authored-by: Jean-Robin <[email protected]>
Co-authored-by: Jean-Robin <[email protected]>
Co-authored-by: Jean-Robin <[email protected]>
Co-authored-by: Jean-Robin <[email protected]>
| tp.Core().run() | ||
|
|
||
| scenario = tp.create_scenario(scenario_config) | ||
| tp.submit(scenario) | ||
|
|
||
| # Retrieve all submission. | ||
| print(f'(2) Number of submissions: {len(tp.get_submissions())}.') | ||
|
|
||
| # Get the latest created submission of the scenario. | ||
| tp.get_latest_submission(scenario) | ||
|
|
||
| # Then delete it. | ||
| tp.delete(submission) | ||
| print(f'(3) Number of submissions: {len(tp.get_submissions())}.') |
toan-quach
deleted the
feature/core/#612-added-doc-for-exposing-submission-api
branch
#612