Olatunji Ruwase 65ab64481f Add API for updating ZeRO gradients (#6590) | 1 week ago | |
---|---|---|
.. | ||
_data | 5df12a4a85 DeepNVMe tutorial (#6449) | 1 month ago |
_includes | 908d616072 Website posts and tutorial improvements (#1799) | 2 years ago |
_layouts | 908d616072 Website posts and tutorial improvements (#1799) | 2 years ago |
_pages | 488a823f64 New integration - CometMonitor (#5466) | 5 months ago |
_posts | ab6b1e16bb Add Japanese blog for DeepSpeed-FastGen (#4651) | 11 months ago |
_sass | 4deb40de67 Update to fix sidebar over text (#5567) | 4 months ago |
_tutorials | a1f98bdc70 AIO CPU Locked Tensor (#6592) | 1 week ago |
assets | 5df12a4a85 DeepNVMe tutorial (#6449) | 1 month ago |
code-docs | 65ab64481f Add API for updating ZeRO gradients (#6590) | 1 week ago |
404.html | 5042dc0085 drafting Jekyll webpage (#143) | 4 years ago |
CNAME | 85cc16aed2 Restoring CNAME (#145) | 4 years ago |
Gemfile | 0584689d43 Fix docs building guide (#5825) | 2 months ago |
README.md | 0584689d43 Fix docs building guide (#5825) | 2 months ago |
_config.yml | f876d81d34 DeepSpeed4Science (#4357) | 1 year ago |
contributing.md | 6379292c62 Improving deepspeed.ai website (#269) | 4 years ago |
index.md | 01fe65b300 DeepSpeed on Window blog (#6364) | 2 months 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
afterward 😊.
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
Depending on your environment, you may need to add webrick
to avoid the following error:
gems/gems/jekyll-3.9.5/lib/jekyll/commands/serve/servlet.rb:3:in `require': cannot load such file -- webrick (LoadError)
bundle add webrick
You can now start a local webserver via:
bundle exec jekyll serve
The website should now be accessible at http://localhost:4000
Use the following steps to update the public API documentation.