The first section of this tutorial covers setting up our project. This includes the following tasks:
- Creating an account and repo in DagsHub
- Installing DVC as well as the optional installation needed to use remote caches for a project (we assume you have Git installed and are familiar with it to some extent).
- Project initialization in Git and DVC
- Creating a virtualenv and installing the needed requirements for the first part of the project
If you are familiar with these steps, you can skip to the next part which covers pipeline creation.
...is really easy. Just sign up.
Then, after logging in, create a new repo, simply by clicking on the plus sign and create repository in the
This opens up a dialog, which should be somewhat familiar, in which you can set the repository name, description and other options.
For this tutorial, fill in the Name and description, and leave everything else with the default settings.
Note the Local DVC cache URL setting, which is unique to DagsHub. We will get back to it later in the tutorial.
Done with repo creation. On to project initialization.
We need to make sure we have Git and DVC installed on our computer.
We won't cover Git installation here, but if you need it, here is a link to an installation guide.
This tutorial assumes a Python 3 installation.
Make sure you aren't using Python 2 by mistake, using
For full documentation and all options for installation of DVC, see the official docs.
DVC is actually a python module. You can run it from your OS environment or from your currently activated python environment. As such, the fastest way to install DVC is using pip. Just open a terminal and type:
pip install dvc
This tutorial was last updated to DVC version 1.1.7 . If you are using an older version, please update. If you are using a newer version, be aware that the behavior of some commands may change.
Setting up our project¶
Create a directory name "dagshub_mnist" for the project somewhere on your computer. Open a terminal and input the following:
cd path/to/folder/dagshub_mnist git init dvc init
The last command initializes the project as a DVC project, which sets up the following directory structure:
. ├── .dvc │ ├── .gitignore │ ├── config │ ├── plots │ │ ├── confusion.json │ │ ├── default.json │ │ ├── scatter.json │ │ └── smooth.json │ └── tmp │ └── index └── .git ┊
This is somewhat similar to the .git folder contained in every git repo, except some of its contents will be tracked using git.
.dvc/configis similar to
.git/config. By default it's empty. More on this later on.
.dvc/.gitignoremakes sure git ignores dvc internal files that shouldn't be tracked by git.
.dvc/plotscontains predefined templates for plots you can generate using
dvc- more info here.
.dvc/tmpis used by dvc to store temporary files, this shouldn't interest the average user.
.dvc/cachedoesn't exist yet, but it is where DVC will keep the different versions of our data files. It's very similar in principle to
Now, we will set the remote to our repo on dagshub.com. This can be done using the following command:
git remote add origin https://dagshub.com/<username>/<repo-name>.git
mkdir code data metrics
Creating a virtual environment and installing requirements¶
We strongly recommend using a virtual environment to run the code in this tutorial. You may use the environment manager
of your choosing. In this example we will use
In the project directory type the following commands:
virtualenv venv echo venv/ >> .gitignore source venv/bin/activate
virtualenv venv echo venv/ >> .gitignore venv\Scripts\activate.bat
The first command makes sure the virtual environment packages are not tracked by Git.
The second command activates our virtual python environment. This ensures that no python package we use contaminates our global python installation.
The rest of this tutorial should be executed using this environment
If you exit the shell session, or want to create another, make sure to activate the virtual environment in that shell session first.
To install the requirements for the first part of this project, simply download the requirements.txt into your project folder.
Alternatively, you can create a file called requirements.txt and copy the following into it:
numpy==1.15.4 pandas==0.23.4 python-dateutil==2.7.5 pytz==2018.7 scikit-learn==0.20.2 scipy==1.2.0 six==1.12.0 sklearn==0.0
Now, to install them type:
pip install -r requirements.txt
Committing progress to Git¶
Let's check the Git status of our project:
$ git status -s A .dvc/.gitignore A .dvc/config A .dvc/plots/confusion.json A .dvc/plots/default.json A .dvc/plots/scatter.json A .dvc/plots/smooth.json ?? .gitignore ?? requirements.txt
Now let's commit this to Git using the command line:
git add . git commit -m "Initialized project" git push -u origin master
Let's open up our repo on DagsHub. It should look something like this:
The top part should look familiar to anyone that has used a Git server before. However, notice the bottom window. This is a new addition in DagsHub, and will, later on in this tutorial, show our data pipeline.
In the next section, we will use dvc to define our pipeline. That is where the magic happens.