Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
nanne-aben committed Oct 4, 2023
1 parent 3731b42 commit f3d6d0e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,6 @@ The advantages include:
## Documentation
Please see our documentation on [readthedocs](https://typedspark.readthedocs.io/en/latest/index.html).

## Demo videos

### IDE demo

https://github.com/kaiko-ai/typedspark/assets/47976799/e6f7fa9c-6d14-4f68-baba-fe3c22f75b67

You can find the corresponding code [here](docs/videos/ide.ipynb).

### Jupyter / Databricks notebooks demo

https://github.com/kaiko-ai/typedspark/assets/47976799/39e157c3-6db0-436a-9e72-44b2062df808

You can find the corresponding code [here](docs/videos/notebook.ipynb).

## Installation

You can install ``typedspark`` from [pypi](https://pypi.org/project/typedspark/) by running:
Expand All @@ -66,6 +52,20 @@ By default, ``typedspark`` does not list ``pyspark`` as a dependency, since many
pip install "typedspark[pyspark]"
```

## Demo videos

### IDE demo

https://github.com/kaiko-ai/typedspark/assets/47976799/e6f7fa9c-6d14-4f68-baba-fe3c22f75b67

You can find the corresponding code [here](https://github.com/kaiko-ai/docs/videos/ide.ipynb).

### Jupyter / Databricks notebooks demo

https://github.com/kaiko-ai/typedspark/assets/47976799/39e157c3-6db0-436a-9e72-44b2062df808

You can find the corresponding code [here](https://github.com/kaiko-ai/docs/videos/notebook.ipynb).

## FAQ

**I found a bug! What should I do?**</br>
Expand Down
6 changes: 6 additions & 0 deletions docs/source/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ By default, ``typedspark`` does not list ``pyspark`` as a dependency, since many
pip install "typedspark[pyspark]"
Demo videos
===========

* IDE demo: `video <https://github.com/kaiko-ai/typedspark/assets/47976799/e6f7fa9c-6d14-4f68-baba-fe3c22f75b67>`_ and `code <https://github.com/kaiko-ai/docs/videos/ide.ipynb>`_.
* Jupyter / Databricks Notebook demo: `video <https://github.com/kaiko-ai/typedspark/assets/47976799/39e157c3-6db0-436a-9e72-44b2062df808>`_ and `code <https://github.com/kaiko-ai/docs/videos/notebook.ipynb>`_.

FAQ
===

Expand Down

0 comments on commit f3d6d0e

Please sign in to comment.