Skip to content

Change venv name to mlcflow #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anandhu-eng wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Change venv name to mlcflow #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dab759c
Change venv name to mlcflow
anandhu-eng Apr 16, 2026
02d2811
Update mlcflow_linux.sh
anandhu-eng Apr 16, 2026
f0efbbc
Update test-installer-curl.yml
anandhu-eng Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test-installer-curl.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ jobs:
if [[ "${{ matrix.scenario }}" == "custom-venv" ]]; then
VENV_DIR="/tmp/custom_mlcflow_venv"
else
VENV_DIR="$HOME/.mlcflow_venv"
VENV_DIR="$HOME/.mlcflow"
Copy link
Copy Markdown
Contributor

@arjunsuresh arjunsuresh May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use "." In our readme right?

fi

echo "Expected venv directory: $VENV_DIR"
Expand Down Expand Up @@ -421,7 +421,7 @@ jobs:
if [[ "${{ matrix.scenario }}" == "custom-venv" ]]; then
VENV_DIR="/tmp/custom_mlcflow_venv"
else
VENV_DIR="/root/.mlcflow_venv"
VENV_DIR="/root/.mlcflow"
fi

echo "Expected venv directory: $VENV_DIR"
Expand Down
14 changes: 7 additions & 7 deletions docs/install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This installer provides a **one-command setup** for the MLCFlow package and the

**After installation, activate the virtual environment** to use MLCFlow commands:
```bash
source ~/.mlcflow_venv/bin/activate
source ~/.mlcflow/bin/activate
```

## Supported Platforms
Expand Down Expand Up @@ -75,7 +75,7 @@ source ~/.mlcflow_venv/bin/activate
↓
┌─────────────────────────────────────────────────────────────┐
│ 5. Create Virtual Environment │
│ - Location: ~/.mlcflow_venv (or custom) │
│ - Location: ~/.mlcflow (or custom) │
└─────────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────┐
Expand Down Expand Up @@ -147,7 +147,7 @@ bash mlcflow_linux.sh --yes --quiet
|----------|-------------|---------|
| `--yes` | Auto-confirm all prompts (non-interactive mode) | Interactive |
| `--upgrade` | Upgrade mlcflow if already installed | Skip if present |
| `--venv-dir <path>` | Custom virtual environment directory | `~/.mlcflow_venv` |
| `--venv-dir <path>` | Custom virtual environment directory | `~/.mlcflow` |
| `--mlc-repo <repo>` | Repository in format `owner@repo` | `mlcommons@mlperf-automations` |
| `--mlc-repo-branch <branch>` | Git branch to clone | `dev` |
| `--install-python` | Auto-install Python if incompatible | Prompt user |
Expand Down Expand Up @@ -227,9 +227,9 @@ Based on this detection, it chooses the appropriate execution method.

```bash
# Activate the virtual environment
source ~/.mlcflow_venv/bin/activate
source ~/.mlcflow/bin/activate

# Your prompt should change to show (mlcflow_venv) or similar
# Your prompt should change to show (mlcflow) or similar
```

### Verify Installation
Expand All @@ -251,7 +251,7 @@ deactivate
```

### File Locations
- **Virtual Environment**: `~/.mlcflow_venv` (or custom path)
- **Virtual Environment**: `~/.mlcflow` (or custom path)
- **Automation Repository**: `~/MLC/repos/mlcommons@mlperf-automations/`
- **MLC Cache**: `~/MLC/repos/`

Expand All @@ -277,7 +277,7 @@ bash mlcflow_linux.sh --yes
**Solution**:
```bash
# Activate the virtual environment
source ~/.mlcflow_venv/bin/activate
source ~/.mlcflow/bin/activate

# Now mlc command should be available
mlc --help
Expand Down
2 changes: 1 addition & 1 deletion docs/install/mlcflow_linux.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ set -euo pipefail
# ------------------------------------------------------------------------------

MIN_PYTHON_VERSION="3.7"
DEFAULT_VENV_DIR="$HOME/.mlcflow_venv"
DEFAULT_VENV_DIR="$HOME/.mlcflow"
DEFAULT_REPO="mlcommons@mlperf-automations"
DEFAULT_BRANCH="dev"

Expand Down
Loading