Skip to content

Commit

Permalink
improve docker documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Taniya-Das committed Nov 18, 2024
1 parent 51786cb commit 37da8f2
Showing 1 changed file with 1 addition and 31 deletions.
32 changes: 1 addition & 31 deletions docs/Docker reference/Docker.md
Original file line number Diff line number Diff line change
@@ -1,31 +1 @@
# OpenML-Tensorflow container

The docker container has the latest version of OpenML-Tensorflow downloaded and pre-installed. It can be used to run TensorFlow Deep Learning analysis on OpenML datasets.
This document contains information about:

[Usage](#usage): how to use the image

## Usage

These are the steps to use the image:

1. Pull the docker image
```
docker pull taniyadas/openml-tensorflow:latest
```
2. If you want to run a local script, it needs to be mounted first. Mount it into the 'app' folder:
```text
docker run -it -v PATH/TO/CODE_FOLDER:/app taniyadas/openml-tensorflow /bin/bash
```
You can also mount multiple directories into the container (such as your code file directory and dataset directory ) using:
```text
docker run -t -i -v PATH/TO/CODE_FOLDER:/app -v PATH/TO/DATASET_FOLDER:/app/dataset taniyadas/openml-tensorflow /bin/bash
```
3. Please make sure to give the correct path to the dataset. For example,
```text
openml_tensorflow.config.dir = 'dataset/Images'
```
4. Run your code scripts using:
```text
python my_code.py
```
ln -s ../../docker/README.md docs/Docker\ Reference/docker-readme.md

0 comments on commit 37da8f2

Please # to comment.