Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AliMirlou authored Oct 15, 2022
1 parent 143d400 commit d178c54
Showing 1 changed file with 65 additions and 2 deletions.
67 changes: 65 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,65 @@
# phoenix-binaries
This repository is only to release and store Phoenix client binaries. You can find the latest CLI for your platform in "Releases" page.
# Phoenix CLI
Run your data science workloads on high-performance cloud infrastructure in the fewest of steps.

# Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Contact](#contact)

# Installation

You can download and install the CLI for any of the following platforms.

| Supported Platform | Download (Latest) |
| -------------------| -----------------------------|
| Windows | [Link][latest-windows-amd64] |
| Linux | [Link][latest-linux-amd64] |
| macOS | [Link][latest-macos-amd64] |

[latest-windows-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-windows-amd64.exe
[latest-linux-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-linux-amd64
[latest-macos-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-darwin-amd64

To download a specific version, visit the [releases page](https://github.com/RoboEpics/phoenix-binaries/releases).

# Usage

First you need to initialize Phoenix in your data science project directory:

```bash
phx init
```

This will create a `.phoenix` folder inside your project root directory.

Next you need to login to the Phoenix Platform by running this command and filling out your credentials in the prompts:

```bash
phx login
```

As easily as that, now your project is ready for the cloud.

## Running jobs

You can run a job:

```bash
phx run --cluster $CLUSTER_NAME --flavor $FLAVOR_NAME --name $YOUR_JOB_NAME $COMMAND $ARGS
```

## Creating Jupyter Notebooks

You can also run a Jupyter Notebook on-demand and attach it to Google Colab as an external powerful non-interrupting runtime kernel:

```bash
phx jupyter create --cluster $CLUSTER_NAME --flavor $FLAVOR_NAME --name $YOUR_JUPYTER_INSTANCE_NAME
phx jupyter attach
```

Now, as long as your terminal is open, you can connect your Colab to this runtime using the "Connect to a local runtime" button in Colab interface.

You can read more about how to connect Colab to a local runtime [here](https://research.google.com/colaboratory/local-runtimes.html).

# Contact
If you had any questions or problems, join our server on [**Discord**](https://discord.gg/8DMfjmn6gc).

0 comments on commit d178c54

Please sign in to comment.