https://github.com/joehalliwell/useful-ai

A guide to building useful AI systems
https://github.com/joehalliwell/useful-ai

Last synced: 14 days ago
JSON representation

A guide to building useful AI systems

• Host: GitHub
• URL: https://github.com/joehalliwell/useful-ai
• Owner: joehalliwell
• License: cc-by-sa-4.0
• Created: 2022-01-30T10:00:03.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-30T11:34:00.000Z (12 months ago)
• Last Synced: 2023-12-30T12:27:48.309Z (12 months ago)
• Language: TeX
• Homepage: https://joehalliwell.com/useful-ai
• Size: 1.69 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Useful AI

Source code for [Useful AI](http://joehalliwell.com/useful-ai), a guide to

building AI systems that do useful work.

This work is licensed under a

[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].

[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/

## Usage

### Building the book

If you'd like to develop and/or build the Useful AI book, you should:

1. Clone this repository

2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)

3. (Optional) Edit the books source files located in the `useful-ai/` directory

4. Run `jupyter-book clean useful-ai/` to remove any existing builds

5. Run `jupyter-book build useful-ai/`

A fully-rendered HTML version of the book will be built in `useful-ai/_build/html/`.

### Hosting the book

Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

## Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/joehalliwell/useful-ai/graphs/contributors).

## Credits

This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).