Gowtham Prudhvi c66f388156 Fix few typos in the docs (#418) | 4 years ago | |
---|---|---|
.. | ||
_data | 2dea61f285 ZeRO tutorials (#384) | 4 years ago |
_layouts | 7ae8f8bc9b DeepSpeed webinar announcement (#301) | 4 years ago |
_pages | 7d91be9765 Minor doc fixes (#417) | 4 years ago |
_posts | 7d91be9765 Minor doc fixes (#417) | 4 years ago |
_tutorials | c66f388156 Fix few typos in the docs (#418) | 4 years ago |
assets | a8a8b3d288 Landing page updates (#395) | 4 years ago |
code-docs | 5812e84544 readthedocs yaml configuration (#410) | 4 years ago |
news | 4d735946b8 Web edits (#146) | 4 years ago |
404.html | 5042dc0085 drafting Jekyll webpage (#143) | 4 years ago |
CNAME | 85cc16aed2 Restoring CNAME (#145) | 4 years ago |
Gemfile | 5042dc0085 drafting Jekyll webpage (#143) | 4 years ago |
Gemfile.lock | ac12833ea7 Jekyll installation instructions (#351) | 4 years ago |
README.md | 9e83ef21ea Update installation instructions (#362) | 4 years ago |
_config.yml | ea92ed29bb Update _config.yml | 4 years ago |
contributing.md | 6379292c62 Improving deepspeed.ai website (#269) | 4 years ago |
index.md | 6bb5c69f48 Website edits (#398) | 4 years ago |
This directory includes the source code for the website and documentation of DeepSpeed. The code-docs/
directory is used to build deepspeed.readthedocs.io.
deepspeed.ai is the recommended way to read all DeepSpeed documentation. Directly viewing the Markdown files in this directory will not include images and other features.
You can serve the DeepSpeed website locally. This is especially useful for development.
The DeepSpeed website relies on Jekyll. There are several guides for installation. The instructions below assume you are in an Ubuntu environment and have been tested on WSL.
First ensure that you have the necessary packages (e.g., make
and zlib
).
sudo apt-get install build-essential zlib1g-dev ruby-full
Add these lines to your .bashrc
or equivalent to ensure you have permissions to install Ruby packages without sudo
.
export GEM_HOME="$HOME/gems"
export PATH="$HOME/gems/bin:$PATH"
Don't forget to source ~/.bashrc
afterwards 😊.
Now we can install Jekyll and Bundler:
gem install jekyll bundler
We now need to install the required Ruby packages for the website.
NOTE: you should change to this folder (i.e., docs) before running the installation command to avoid this error:
Could not locate Gemfile
NOTE: this step frequently hangs when connected to a VPN (including MSVPN). Simply disconnect for the package installation.
bundle install
You can now start a local webserver via:
bundle exec jekyll serve
The website should now be accessible at http://localhost:4000