You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/workflows/design_workflows.rst
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -146,9 +146,14 @@ For example:
146
146
Branches
147
147
--------
148
148
149
-
Branches are purely an organizational concept, used to group design workflows under a single name. If you do not wish to interact with them, ignore the ``branch_id`` on a DesignWorkflow, and it will be handled for you.
149
+
Branches are purely an organizational concept, used to group design workflows with similar goals under a single name.
150
+
They are the primary organizational concept of AI assets as displayed in our web UI.
151
+
In the context of the Citrine Python client, they can be thought of as a bucket of design workflows.
152
+
If you do not wish to interact with them in the python client, ignore the ``branch_id`` on a DesignWorkflow, and it will be handled for you.
150
153
151
-
A branch has a name, along with any number of design workflows. A DesignWorkflow can be created and retrieved, and you can list all design workflows on a branch. You can still list all design workflows on the project as before.
154
+
A branch has a name, along with any number of design workflows.
155
+
A DesignWorkflow can be created and retrieved, and you can list all design workflows on a branch.
156
+
You can still list all design workflows on the project as before.
152
157
153
158
.. code:: python
154
159
@@ -183,6 +188,14 @@ A branch has a name, along with any number of design workflows. A DesignWorkflow
183
188
When you're done with a branch, it can be archived, removing it from the results of ``list`` and setting the ``archived`` flag.
184
189
``list_archived`` lists all archived branches in a project. An archived branch can be restored via its unique ID.
185
190
191
+
Note that archiving branches is independent of archiving the design workflows contained within it.
192
+
Archiving a branch will hide the entire branch from default displays in the web UI.
193
+
As a result, the design workflows it contained within it will also be hidden.
194
+
Yet archiving th branch will *not* change the archived status of the contained design workflows in the context of design workflow listing methods.
195
+
196
+
Similarly, archiving a design workflow will result in its executions and relevant assets no longer being displayed within the branch.
197
+
Thus, archiving all the design workflows contained within a branch will result in a hidden branch on the web UI, but the archival status of the branch will not change.
0 commit comments