Skip to content
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.

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

Using zenml login for templates #26

Merged
merged 2 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion copier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ _tasks:
echo " pip install -r requirements.txt"
echo " # Start the ZenML UI (optional; you'll also need the zenml[server] Python"
echo " # package installed"
echo " zenml up"
echo " zenml login --local"
echo " python run.py"
echo "Next, you should take a look at the '{{ _copier_conf.dst_path }}/README.md' file in the generated project."
echo "Happy coding!"
Expand Down
2 changes: 1 addition & 1 deletion template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ zenml integration install sklearn pandas -y
zenml init

# Start the ZenServer to enable dashboard access
zenml up
zenml login --local

# Run the feature engineering pipeline
python run.py --feature-pipeline
Expand Down
8 changes: 4 additions & 4 deletions template/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
"source": [
"zenml_server_url = \"PLEASE_UPDATE_ME\" # in the form \"https://URL_TO_SERVER\"\n",
"\n",
"!zenml connect --url $zenml_server_url"
"!zenml login $zenml_server_url"
]
},
{
Expand Down Expand Up @@ -401,9 +401,9 @@
" # Only spin up a local Dashboard in case you aren't already connected to a remote server\n",
" if Environment.in_google_colab():\n",
" # run ZenML through a cloudflare tunnel to get a public endpoint\n",
" !zenml up --port 8237 & cloudflared tunnel --url http://localhost:8237\n",
" !zenml login --local --port 8237 & cloudflared tunnel --url http://localhost:8237\n",
" else:\n",
" !zenml up"
" !zenml login --local"
]
},
{
Expand Down Expand Up @@ -1126,7 +1126,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.10"
"version": "3.11.3"
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Python version upgrade needs documentation update

The codebase lacks explicit Python version requirements documentation. While upgrading from Python 3.8.10 to 3.11.3:

  • No minimum Python version is specified in requirements.txt or other configuration files
  • Dependencies like ZenML (>=0.50.0, >=0.52.0) and scikit-learn are used but their Python version compatibility is not documented

Please:

  • Add Python version requirements to requirements.txt or create a dedicated runtime.txt
  • Document minimum Python version in README.md
  • Consider adding Python version classifiers if using setup.py
🔗 Analysis chain

Verify Python version compatibility requirements

The kernel version has been upgraded from 3.8.10 to 3.11.3. While this brings access to newer Python features, it's important to ensure:

  1. All dependencies support Python 3.11
  2. Documentation reflects the minimum Python version requirement

Let me gather more information about Python version requirements by checking additional files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if Python version requirements are documented

# Test: Look for Python version requirements in README or setup files
rg -i "python.*version|requires.*python"

Length of output: 385


Script:

#!/bin/bash
# Check for Python version specifications in setup files, requirements files, and other common locations
fd -e txt -e yaml -e yml -e toml -e cfg -e ini | xargs rg -i "python|version"

# Also check for any requirements.txt or similar files
fd "requirements|setup.py|pyproject.toml|environment.yml"

# Check the content of any found requirement files
fd "requirements.txt" -x cat {}

Length of output: 989

}
},
"nbformat": 4,
Expand Down
Loading