Skip to content

Commit

Permalink
DOCS-#447: Add note about installation and setup in README (#449)
Browse files Browse the repository at this point in the history
* add small note about setup and installation

* Update README.md

Co-authored-by: Doris Lee <dorisjunglinlee@gmail.com>
  • Loading branch information
cgarciae and dorisjlee committed Jan 30, 2022
1 parent a7e2cf7 commit ae2d55e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ df = pd.read_csv("https://raw.githubusercontent.com/lux-org/lux-datasets/master/
df
```
When the dataframe is printed out, Lux automatically recommends a set of visualizations highlighting interesting trends and patterns in the dataset.

<img src="https://github.com/lux-org/lux-resources/blob/master/readme_img/basicDemo.gif?raw=true"
alt="Basic recommendations in Lux"
style="width:900px" />
Expand Down Expand Up @@ -134,6 +135,8 @@ To find out more about other features in Lux, see the complete documentation on

# Installation & Setup

> **Note**: Lux's official package name is `lux-api` (not `lux`). After installing the package, remember to run the setup instructions for your notebook IDE, e.g., [jupyter notebook](#setup-in-jupyter-notebook-vscode-jupyterhub) and [jupyter lab](#setup-in-jupyter-lab).
To get started, please follow both the installation and setup instructions in your command line.
`lux-api` can be installed through [PyPI](https://pypi.org/project/lux-api/) or [conda-forge](https://github.com/conda-forge/lux-api-feedstock).

Expand Down Expand Up @@ -186,4 +189,4 @@ Drop us a note [here](https://docs.google.com/forms/d/e/1FAIpQLSe4YL2WsblqjB13Fp
- Try out these hands-on [exercises](https://mybinder.org/v2/gh/lux-org/lux-binder/master?urlpath=lab/tree/exercise) or [tutorials](https://mybinder.org/v2/gh/lux-org/lux-binder/master?urlpath=lab/tree/tutorial) on [Binder](https://mybinder.org/v2/gh/lux-org/lux-binder/master?urlpath=lab/). Or clone and run [lux-binder](https://github.com/lux-org/lux-binder) locally.
- Join our community [Slack](https://communityinviter.com/apps/lux-project/lux) to discuss and ask questions.
- Check out [our paper](https://arxiv.org/pdf/2105.00121.pdf) for more details on how Lux works under the hoods.
- Report any bugs, issues, or requests through [Github Issues](https://github.com/lux-org/lux/issues).
- Report any bugs, issues, or requests through [Github Issues](https://github.com/lux-org/lux/issues).

0 comments on commit ae2d55e

Please sign in to comment.