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.

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

Jump to bottom

Moved Jupyter guide to docs #242

Merged
merged 4 commits into from
Mar 19, 2019
Merged

Moved Jupyter guide to docs #242

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0edf02f
Moved Jupyter guide to docs
tovbinm Mar 13, 2019
9ba22e3
update
tovbinm Mar 13, 2019
ef79fd5
updates
tovbinm Mar 13, 2019
6b82757
Merge branch 'master' into mt/jup-docs
tovbinm Mar 17, 2019
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
Prev Previous commit
Next Next commit
update
  • Loading branch information
@tovbinm
tovbinm committed Mar 13, 2019
commit 9ba22e3bf758407015134990c6b80dacafa2aaa2
21 changes: 11 additions & 10 deletions docs/examples/Running-from-Jupyter-Notebook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Prerequisites:
Installation using pip

```$xslt
sudo pip install beakerx
sudo beakerx install
pip install beakerx
beakerx install
```

Installation using conda
Expand All @@ -35,28 +35,29 @@ Reference : [BeakerX Documentation](http:https://beakerx.com/documentation)

BeakerX provides a [docker container image](https://hub.docker.com/r/beakerx/beakerx/) on docker hub.

Assuming your Transmogrify source code is downloaded at `/Users/rdua/work/github/rajdeepd/TransmogrifAI`. You can use the `docker run` command to start the container.

We need the directory above so that we can mount sample notebooks and dataset
into the container using docker volumes.

### Increase the RAM available to Docker container

Increase the Memory available to docker containers from the docker UI as shown below


![docker-settings][docker-settings]

[docker-settings]: https://github.com/salesforce/TransmogrifAI/raw/master/resources/docker_memory_settings.png

### Set TransmogrifAI_HOME

Assuming your Transmogrify source code is downloaded at `/Users/johndoe/TransmogrifAI` run the command:

```bash
export TransmogrifAI_HOME=<TransmogrifAI installation dir>
export TransmogrifAI_HOME="/Users/johndoe/TransmogrifAI"
```

We need the directory above so that we can mount sample notebooks and dataset
into the container using docker volumes.

### Run the BeakerX Container

You can use the `docker run` command to start the container as follows:

```bash
docker run -p 8888:8888 -v $TransmogrifAI_HOME/helloworld/notebooks:/home/beakerx/helloworld-notebooks \
-v $TransmogrifAI_HOME/helloworld:/home/beakerx/helloworld --name transmogrifai-container beakerx/beakerx
Expand Down Expand Up @@ -85,7 +86,7 @@ On opening the image in the browser you will notice that in the home page

### Sample Notebooks

Following notebooks are currently available
Following notebooks are currently available:

#### Titanic Binary Classification

Expand Down