Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
roquelopez committed May 1, 2024
1 parent b6d685f commit 90c71b0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This repository is part of New York University's implementation of the


## Documentation
Documentation is available [here](https://alpha-automl.readthedocs.io/). You can also try this [online demo](https://alpha-automl.hsrn.nyu.edu/) (1 hour limit per session).
Documentation is available [here](https://alpha-automl.readthedocs.io/).


## Installation
Expand All @@ -39,7 +39,9 @@ pip install git+https://github.com/VIDA-NYU/alpha-automl@devel
```


## Trying it using Docker
## Docker

### Pre-built Docker Image
We provide pre-built docker images with Jupyter and Alpha-AutoML pre-installed that you can use to quickly test Alpha-AutoML.
To test it, you can run the following command in your machine, and open Jupyter Notebook on your browser:

Expand All @@ -59,7 +61,7 @@ docker run -p 8888:8888 ghcr.io/vida-nyu/alpha-automl --NotebookApp.token=''
```


## Building a Docker image from scratch
### Docker Image From Scratch
If you need to build an image from sources, you can use our [Dockerfile](https://github.com/VIDA-NYU/alpha-automl/blob/devel/Dockerfile). You can use a docker-build argument to select the packages that will be installed in the image (e.g., `full`, `timeseries`, `nlp`, etc) as follows:

```
Expand Down

0 comments on commit 90c71b0

Please sign in to comment.