Olatunji Ruwase 5c3ebd7ede Clone tensors to avoid torch.save bloat (#3348) | 1 year ago | |
---|---|---|
.. | ||
_data | 859d7c92ab Automatic Tensor Parallelism Blog Links (#2877) | 1 year ago |
_includes | 908d616072 Website posts and tutorial improvements (#1799) | 2 years ago |
_layouts | 908d616072 Website posts and tutorial improvements (#1799) | 2 years ago |
_pages | 6938c449de Add snip_momentum structured pruning which can support higher sparse ratio with minor accuracy loss (#3300) | 1 year ago |
_posts | e0e808503e Update 2020-09-09-sparse-attention.md (#3432) | 1 year ago |
_sass | 8a35daf061 Tune webpage width (#1829) | 2 years ago |
_tutorials | 82991df054 Doc updates (#3520) | 1 year ago |
assets | d92539509b Auto TP Tutorial with T5 Example (#2962) | 1 year ago |
code-docs | 5c3ebd7ede Clone tensors to avoid torch.save bloat (#3348) | 1 year 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 |
README.md | 377c770a61 Updating docs README (#2587) | 1 year ago |
_config.yml | 859d7c92ab Automatic Tensor Parallelism Blog Links (#2877) | 1 year ago |
contributing.md | 6379292c62 Improving deepspeed.ai website (#269) | 4 years ago |
index.md | 58c4d23092 fix spelling error with docs/index.md (#3443) | 1 year 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
Use the following steps to update the public API documentation.