[v4.0] Make a bunch of updates to the docs. #1014
Conversation
Some was made incorrect by the v4.0 release, but there was also a lot of old information that hasn't been corrct for some time. I corrected as much of it as I could find. This deliberately omits a new section in the design space docs on hierarchical design spaces. That will be added separately, pre-release.
| --------------- | ||
|
|
||
| After registering an asset, the ``status`` command can be used to obtain a static readout of the state of the asset on the platform (e.g., VALID, INVALID, VALIDATING, SUCCEEDED, FAILED, INPROGRESS). | ||
| After registering an asset, the ``status`` command can be used to obtain a static readout of the state of the asset on the platform (e.g., READY, INVALID, VALIDATING, SUCCEEDED, FAILED, INPROGRESS). |
There was a problem hiding this comment.
Ironically, VALID is not a valid state
| if project.name == project_name), None) | ||
| project = next((project for project in all_projects if project.name == project_name), None) | ||
| or use the :func:`~citrine.seeding.find_or_create.find_or_create_project` convenience method: |
There was a problem hiding this comment.
Was there a reason we previously didn't mention find_or_create_project? Or was this just written before it was created?
| Hierarchical Design Space | ||
| ------------------------- | ||
|
|
There was a problem hiding this comment.
This is intentionally left blank for now. @jspeerless has offered to put together this section before release.
There was a problem hiding this comment.
Wrapping design spaces in ProductDesignSpace, dropping references to EnumeratedDesignSpace, and mentioning that DataSourceDesignSpace and FormulationDesignSpace must be part of a ProductDesignSpace.
| Validation status can be one of the following states: | ||
|
|
||
| - **Created:** The module/workflow has been registered with a project and has been queued for validation. | ||
| - **Created:** The module/workflow has been registered with a project, but validation has not begun. |
There was a problem hiding this comment.
Although the SDK automatically starts validation, the UI does not. Also, in the SDK, you can prevent automatically training a predictor when registering or updating with train=False.
There was a problem hiding this comment.
Dehydrated predictors are no longer supported. Subpredictor training_data is hoisted up to the graph predictor in the backend; by disallowing it in the SDK, we can finally get rid of that code. And all the examples should register only GraphPredictor.
Some was made incorrect by the v4.0 release, but there was also a lot of old information that hasn't been corrct for some time. I corrected as much of it as I could find.
This deliberately omits a new section in the design space docs on hierarchical design spaces. That will be added separately, pre-release.
PR Type:
Adherence to team decisions