Required document change as per updated CMF GUI#351
Conversation
There was a problem hiding this comment.
Change this as per new ui.
varkha-d-sharma
changed the title
| 1. Ensure the [CMF Server is running](../setup/index.md#install-cmf-server-with-gui) | ||
| 2. Open your browser and navigate to the server URL (default: `http://your-server-ip:80`) | ||
| 3. The GUI will display the available pipelines in the sidebar | ||
| 3. The GUI will display the available pipelines on home page of CMF GUI |
There was a problem hiding this comment.
make 3rd step as a "3. The GUI will display the available pipelines on the home page."
| ## Artifacts View | ||
|
|
||
| The Artifacts page displays all datasets, models, and metrics tracked by CMF. You can browse, search, and explore artifact metadata, versions, and lineage. | ||
| The Artifacts page displays all datasets, models, metrics, labels, and other tracked artifacts managed by CMF. Artifacts are organized by pipeline and stage, allowing users to quickly locate outputs generated during different phases of the machine learning workflow. |
There was a problem hiding this comment.
mention input artifact as well.
| - **Artifact Listing**: View all artifacts with their types (Dataset, Model, Metrics) | ||
| - **Search & Filter**: Find specific artifacts by name, type, or properties | ||
| - **Artifact Details**: Examine metadata, custom properties, and version information | ||
| - **Pipeline Navigation**: Browse artifacts for individual pipelines. |
There was a problem hiding this comment.
it should be like this: Pipeline Navigation: Select a pipeline to view its associated stages.
Stage-Based Filtering: Click on a stage (such as Prepare, Featurize, Train, or Evaluate) to display the artifacts generated or used within that stage.
| ## Executions View | ||
|
|
||
| The Executions page displays all pipeline runs and execution history. You can view execution details, parameters, and associated artifacts for each run. | ||
| The Executions page displays all pipeline runs and execution history. Users can inspect execution details and understand how artifacts were generated throughout the ML lifecycle. |
There was a problem hiding this comment.
it should be The Executions page displays all pipeline runs and execution history. You can view execution details, parameters, and associated artifacts for each run to understand how outputs were generated throughout the ML lifecycle.
| - **Execution Details**: See parameters, properties, and metadata for each run | ||
| - **Filtering & Search**: Find specific executions by name, type, or properties | ||
| - **Execution History**: View execution timelines and timestamps. | ||
| - **Execution Details**:Inspect execution parameters, metadata, and associated artifacts. |
There was a problem hiding this comment.
add pipeline navigation and stage based executions
| - **Execution History**: View execution timelines and timestamps. | ||
| - **Execution Details**:Inspect execution parameters, metadata, and associated artifacts. | ||
| - **Filtering & Search**: Find specific executions using metadata, execution names, or properties. | ||
| - **Pipeline Context**: Understand how executions relate to specific pipeline stages. |
There was a problem hiding this comment.
remove pipeline context
| 3. **Browser Compatibility**: Modern browser (Chrome, Firefox, Safari, Edge) | ||
|
|
||
| --- | ||
| ## Interactive Exploration |
| ### 2. Artifacts Table | ||
|
|
||
| The main table displays artifacts with the following columns: | ||
| ### 2. Artifacts Card |
There was a problem hiding this comment.
instead of card mention "card grid" for both artifact and execution tab
|
|
||
| | Column | Description | | ||
| | Card Data | Description | | ||
| |--------|-------------| |
There was a problem hiding this comment.
change this table based on ui content
|
|
||
| ### 4. Pipeline Selection | ||
| Users can select a pipeline from the left navigation panel. Once a pipeline is selected, all stages associated with that pipeline become available for exploration. | ||
|
|
There was a problem hiding this comment.
instead of 3[step 3,4,5] points convert this into 2 points.
| @@ -64,20 +92,20 @@ The main table displays artifacts with the following columns: | |||
| 2. Select a pipeline from the **LIST OF PIPELINES** sidebar | |||
There was a problem hiding this comment.
we don't have list of pipelines. read example 1, 2 and 3 carefully and make changes based on our current ui.
|
|
||
| - **Click + icon**: Expands row to show detailed execution metadata, custom properties, and additional information | ||
| - **View Env Details**: Opens Python environment details showing packages and versions used | ||
| - Click the **execution card** or **View All Properties**:: Expands row to show detailed execution metadata, custom properties, and additional information |
There was a problem hiding this comment.
add how you have added description with image for artifact page.
| Selecting a stage filters the execution list to display only executions associated with that stage.This organization helps users understand the progression of data and models throughout the machine learning lifecycle. | ||
|
|
||
|
|
||
| ## Using the Executions Page |
There was a problem hiding this comment.
Read examples carefully and update it as per new ui.
2 participants
Related Issues / Pull Requests
Addresses user difficulty in understanding GUI documentation, as we have updated existing documentation with the newly released CMF GUI.
Also need to add new component diagram for CMF architecture which is needs to be reviewed first then will add in same PR.
Description
In this Pull request Updated the documentation to align with the newly released CMF GUI. This includes comprehensive updates to the codebase as well as the documentation to ensure all user guides and instructions reflect the latest user interface enhancements.
What changes are proposed in this pull request?
This change requires a documentation update
Checklist:
This code requires documentation updates, and I have made corresponding changes to the documentation.