/jax-playground

Primary LanguageJupyter NotebookMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Haiku Playground

My personal playground for exploring the capabilities of Haiku and JAX.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Built With

(back to top)

Getting Started

To get started, you'll need to install the dependencies listed in the Requirements section. Then you can run the commands listed in the Installation section to get started.

Disclaimer: This is a work in progress. Additionally, at this time, the jaxlib package for this project is supported for Linux (Ubuntu 16.04 or later) and macOS (10.12 or later) platforms. Windows users can use JAX on CPU and GPU via the Windows Subsystem for Linux. More information on the jaxlib package and it's installation requirements can be found here.

Prerequisites

This project has a few pre-requisites before you can get up and running. They are as follows:

  1. Python 3.6+
  2. Jupyter Notebook

Installation

Disclaimer: We intend to make this project as easy to use as possible. As such, we hope to migrate to a fully containerized environment in the future. For the time being, users will be asked to install the dependencies listed in the requirements.txt file provided in this repository manually.

  1. Clone the repo
git clone https://github.com/ChrisKalahiki/Haiku-Playground.git
  1. Enter the cloned directory
cd Haiku-Playground
  1. Install the dependencies
pip install -r requirements.txt
  1. Run the notebook
jupyter notebook

(back to top)

Usage

COMING SOON!!!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Chris Kalahiki - @ChrisKalahiki - chris.kalahiki@gmail.com

Project Link: https://github.com/ChrisKalahiki/Haiku-Playground

(back to top)

Acknowledgments

(back to top)