Documentation Flow related issue#346
Conversation
| **Step 1: Activate the Virtual Environment**<br/><br/> | ||
| **Description:** Activates an isolated Python environment to keep project packages separated from global system files. | ||
|
|
||
| === "WSL" |
There was a problem hiding this comment.
replace "wsl" with "Virtual Environment"
| **Description:** Queries the Python package manager to extract technical information regarding the installed cmflib library. | ||
|
|
||
| ```bash | ||
| $ pip show cmflib |
There was a problem hiding this comment.
Add 2 options here: Stable version from PyPI and Lateset version from github.
| ```bash | ||
| $ docker compose -f docker-compose-server.yml up | ||
| ``` | ||
| **Output:** It start your server, Visit to browser at `localshot / 127.0.0.1` |
There was a problem hiding this comment.
correct the localhost path
|
|
||
| ### 2. Storage Backend Architecture | ||
| Ensure you have access credentials and network pathways ready for your chosen artifact repository: | ||
| - **Storage Backend**: local, S3, [MinIOS3](./../cmf_client/minio-server.md), [ssh storage](./../cmf_client/ssh-setup.md) or [OSDF](./../cmf_client/cmf_osdf.md) storage for artifacts. |
There was a problem hiding this comment.
Add local storage documentation link
| **Description:** Launches a custom shell script workflow to execute pre-written testing or processing steps. | ||
|
|
||
| ```bash | ||
| $ . sh ./test_script.sh |
There was a problem hiding this comment.
correct this: it should be sh ./test_script.sh
| **Description:** Retrieves a detailed list of all recorded pipelines or components from your CMF server and saves the output directly into a specified file. | ||
|
|
||
| ```bash | ||
| $ CMF pipeline list -f name of file |
There was a problem hiding this comment.
replace name of file to name_of_file and please add output as well
| ## Component Overview | ||
|
|
||
| Before installing `cmflib` and its components, ensure you have the following: | ||
| * **[CMF Server & GUI](./server_side_installation.md)**: A centralized backend infrastructure that aggregates metadata from clients and hosts the web dashboard. |
There was a problem hiding this comment.
Restore old changes.1. cmflib with CMF Client Installation: A Python library that captures and tracks metadata throughout your ML pipeline, including datasets, models, and metrics.
2. CMF Server with GUI Installation: A centralized server that aggregates metadata from multiple clients and provides a web-based graphical interface for visualizing pipeline executions, artifacts, and lineage relationships.
|
|
||
| > **Note:** If you encounter issues with Python 3.9 on Ubuntu, refer to the [Troubleshooting](#troubleshooting) section at the end of this guide. | ||
| !!! info "Deployment Topology" | ||
| Every operational CMF environment requires exactly one active CMF Server instance. In collaborative environments, multiple data scientists share a single centralized server to collaborate on pipeline lineages. |
| ```bash | ||
| docker compose -f docker-compose-server.yml stop | ||
| ``` | ||
| **Output:** (cmf_env)$ |
There was a problem hiding this comment.
add dir path as well for eg:
(myenv) user@host-name:~/docs/cmf$
something like this.
| $ pip install cmflib | ||
| ``` | ||
| **Output:** | ||
| new release of pip is available: 23.0.1<br /> |
| * Install [Docker Engine](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) with [non-root user](https://docs.docker.com/engine/install/linux-postinstall/) privileges. | ||
| * Install [Docker Compose Plugin](https://docs.docker.com/compose/install/linux/) | ||
|
|
||
| In earlier versions of Docker Compose, `docker compose` was independent of Docker. Hence, `docker-compose` was the command. However, after the introduction of Docker Compose Desktop V2, the compose command became part of Docker Engine. The recommended way to install Docker Compose is by installing a Docker Compose plugin on Docker Engine. For more information - [Docker Compose Reference](https://docs.docker.com/compose/reference/). |
There was a problem hiding this comment.
Restore changes. check our current documentation for this.
2 participants
Related Issues / Pull Requests
• The installation steps for the CMF client (cmflib) are located on a separate page.
• Users are expected to navigate between multiple pages without a clear sequence.
• This breaks the flow and may lead to missed steps during setup.
Description
he initial onboarding flow in the example-get-started guide creates a disjointed user experience because core installation instructions are hosted outside the main tutorial sequence.
What changes are proposed in this pull request?
This change requires a documentation update
Checklist:
My code requires documentation updates, and I have made corresponding changes to the documentation.