Skip to content

Commit

Permalink
Consolidate readme (#356)
Browse files Browse the repository at this point in the history
Signed-off-by: Rafael Vasquez <[email protected]>

Signed-off-by: Rafael Vasquez <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
  • Loading branch information
rafvasq and Rafael Vasquez authored Oct 3, 2022
1 parent 5baeef8 commit 5cdaf07
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,37 +49,29 @@ For a full deployment, we use [Kubeflow Kfctl](https://github.com/kubeflow/kfctl
* #### [MLX on an existing Kubeflow Cluster](./docs/install-mlx-on-kubeflow.md)


## 2. Access the MLX UI
## 2. Access the MLX UI and import Assets to the Catalog

By default, the MLX UI is available at http://<cluster_node_ip>:30380/mlx/

If you deployed on a **Kubernetes** cluster, run the following and look for the External-IP column to find the public IP of a node.
If you deployed on a **Kubernetes** cluster or using **OpenShift**, run the following and look for the External-IP column to find the public IP of a node.

```bash
kubectl get node -o wide
```

If you deployed using **OpenShift**, you can use IstioIngresGateway Route. You can find it in the OpenShift Console or using the CLI.

```bash
oc get route -n istio-system
```

## 3. Import Data and AI Assets in MLX Catalog

For information on how to import data and AI assets using MLX's catalog importer, use this [guide](/docs/import-assets.md).

## 4. Use MLX
## 3. Use MLX

For information on how to use MLX and create assets check out this [guide](/docs/usage-steps.md).

## 5. How to Contribute
## 4. How to Contribute

For information about adding new features, bug fixing, communication
or UI and API setup, refer to this [document](CONTRIBUTING.md).


## 6. Troubleshooting
## 5. Troubleshooting

[MLX Troubleshooting Instructions](/docs/troubleshooting.md)

Expand Down

0 comments on commit 5cdaf07

Please sign in to comment.