[doc] removed read-the-docs (#2932)

pull/2935/head
Frank Lee 2023-02-28 11:28:24 +08:00 committed by GitHub
parent 77b88a3849
commit 9e3b8b7aff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
253 changed files with 0 additions and 2167 deletions

View File

@ -1,30 +0,0 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements/requirements.txt
- requirements: docs/requirements.txt

View File

@ -1,26 +0,0 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = .build
SPHINXAPIDOC ?= sphinx-apidoc
SPHINX_APIDOC_OPTIONS = members
SPHINX_APIDOC_TEMPLATEDIR = _templates/apidoc
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile apidoc
apidoc:
@SPHINX_APIDOC_OPTIONS=$(SPHINX_APIDOC_OPTIONS) $(SPHINXAPIDOC) -f -T -e -M -d 2 -t $(SPHINX_APIDOC_TEMPLATEDIR) -o ./colossalai ../colossalai
# @$(SPHINXAPIDOC) -f -o ./model_zoo ../model_zoo
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

@ -1,3 +0,0 @@
.wy-nav-content {
max-width: 80%;
}

View File

@ -1,9 +0,0 @@
{%- if show_headings %}
{{- basename | e | heading }}
{% endif -%}
.. automodule:: {{ qualname }}
{%- for option in automodule_options %}
:{{ option }}:
{%- endfor %}

View File

@ -1,52 +0,0 @@
{%- macro automodule(modname, options) -%}
.. automodule:: {{ modname }}
{%- for option in options %}
:{{ option }}:
{%- endfor %}
{%- endmacro %}
{%- macro toctree(docnames) -%}
.. toctree::
:maxdepth: {{ maxdepth }}
{% for docname in docnames %}
{{ docname }}
{%- endfor %}
{%- endmacro %}
{%- if is_namespace %}
{{- pkgname | e | heading }}
{% else %}
{{- pkgname | e | heading }}
{% endif %}
{%- if is_namespace %}
.. py:module:: {{ pkgname }}
{% endif %}
{%- if modulefirst and not is_namespace %}
{{ automodule(pkgname, automodule_options) }}
{% endif %}
{%- if subpackages %}
{{ toctree(subpackages) }}
{% endif %}
{%- if submodules %}
{% if separatemodules %}
{{ toctree(submodules) }}
{% else %}
{%- for submodule in submodules %}
{% if show_headings %}
{{- submodule | e | heading(2) }}
{% endif %}
{{ automodule(submodule, automodule_options) }}
{% endfor %}
{%- endif %}
{%- endif %}
{%- if not modulefirst and not is_namespace %}
Module contents
---------------
{{ automodule(pkgname, automodule_options) }}
{% endif %}

View File

@ -1,8 +0,0 @@
{{ header | heading }}
.. toctree::
:maxdepth: {{ maxdepth }}
{% for docname in docnames %}
{{ docname }}
{%- endfor %}

View File

@ -1,5 +0,0 @@
colossalai.amp.amp\_type
========================
.. automodule:: colossalai.amp.amp_type
:members:

View File

@ -1,5 +0,0 @@
colossalai.amp.apex\_amp.apex\_amp
==================================
.. automodule:: colossalai.amp.apex_amp.apex_amp
:members:

View File

@ -1,11 +0,0 @@
colossalai.amp.apex\_amp
========================
.. automodule:: colossalai.amp.apex_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.apex_amp.apex_amp

View File

@ -1,8 +0,0 @@
colossalai.amp.naive\_amp.grad\_scaler
======================================
.. automodule:: colossalai.amp.naive_amp.grad_scaler
:members:

View File

@ -1,5 +0,0 @@
colossalai.amp.naive\_amp.naive\_amp
====================================
.. automodule:: colossalai.amp.naive_amp.naive_amp
:members:

View File

@ -1,16 +0,0 @@
colossalai.amp.naive\_amp
=========================
.. automodule:: colossalai.amp.naive_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.naive_amp.grad_scaler
.. toctree::
:maxdepth: 2
colossalai.amp.naive_amp.naive_amp

View File

@ -1,18 +0,0 @@
colossalai.amp
==============
.. automodule:: colossalai.amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.apex_amp
colossalai.amp.naive_amp
colossalai.amp.torch_amp
.. toctree::
:maxdepth: 2
colossalai.amp.amp_type

View File

@ -1,11 +0,0 @@
colossalai.amp.torch\_amp
=========================
.. automodule:: colossalai.amp.torch_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.torch_amp.torch_amp

View File

@ -1,5 +0,0 @@
colossalai.amp.torch\_amp.torch\_amp
====================================
.. automodule:: colossalai.amp.torch_amp.torch_amp
:members:

View File

@ -1,5 +0,0 @@
colossalai.builder.builder
==========================
.. automodule:: colossalai.builder.builder
:members:

View File

@ -1,11 +0,0 @@
colossalai.builder
==================
.. automodule:: colossalai.builder
:members:
.. toctree::
:maxdepth: 2
colossalai.builder.builder

View File

@ -1,5 +0,0 @@
colossalai.cli.benchmark.benchmark
==================================
.. automodule:: colossalai.cli.benchmark.benchmark
:members:

View File

@ -1,5 +0,0 @@
colossalai.cli.benchmark.models
===============================
.. automodule:: colossalai.cli.benchmark.models
:members:

View File

@ -1,13 +0,0 @@
colossalai.cli.benchmark
========================
.. automodule:: colossalai.cli.benchmark
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.benchmark.benchmark
colossalai.cli.benchmark.models
colossalai.cli.benchmark.utils

View File

@ -1,5 +0,0 @@
colossalai.cli.benchmark.utils
==============================
.. automodule:: colossalai.cli.benchmark.utils
:members:

View File

@ -1,5 +0,0 @@
colossalai.cli.check.check\_installation
========================================
.. automodule:: colossalai.cli.check.check_installation
:members:

View File

@ -1,11 +0,0 @@
colossalai.cli.check
====================
.. automodule:: colossalai.cli.check
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.check.check_installation

View File

@ -1,5 +0,0 @@
colossalai.cli.cli
==================
.. automodule:: colossalai.cli.cli
:members:

View File

@ -1,5 +0,0 @@
colossalai.cli.launcher.hostinfo
================================
.. automodule:: colossalai.cli.launcher.hostinfo
:members:

View File

@ -1,5 +0,0 @@
colossalai.cli.launcher.multinode\_runner
=========================================
.. automodule:: colossalai.cli.launcher.multinode_runner
:members:

View File

@ -1,13 +0,0 @@
colossalai.cli.launcher
=======================
.. automodule:: colossalai.cli.launcher
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.launcher.hostinfo
colossalai.cli.launcher.multinode_runner
colossalai.cli.launcher.run

View File

@ -1,5 +0,0 @@
colossalai.cli.launcher.run
===========================
.. automodule:: colossalai.cli.launcher.run
:members:

View File

@ -1,18 +0,0 @@
colossalai.cli
==============
.. automodule:: colossalai.cli
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.benchmark
colossalai.cli.check
colossalai.cli.launcher
.. toctree::
:maxdepth: 2
colossalai.cli.cli

View File

@ -1,5 +0,0 @@
colossalai.communication.collective
===================================
.. automodule:: colossalai.communication.collective
:members:

View File

@ -1,5 +0,0 @@
colossalai.communication.p2p
============================
.. automodule:: colossalai.communication.p2p
:members:

View File

@ -1,5 +0,0 @@
colossalai.communication.ring
=============================
.. automodule:: colossalai.communication.ring
:members:

View File

@ -1,14 +0,0 @@
colossalai.communication
========================
.. automodule:: colossalai.communication
:members:
.. toctree::
:maxdepth: 2
colossalai.communication.collective
colossalai.communication.p2p
colossalai.communication.ring
colossalai.communication.utils

View File

@ -1,5 +0,0 @@
colossalai.communication.utils
==============================
.. automodule:: colossalai.communication.utils
:members:

View File

@ -1,5 +0,0 @@
colossalai.constants
====================
.. automodule:: colossalai.constants
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.config
=========================
.. automodule:: colossalai.context.config
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.moe\_context
===============================
.. automodule:: colossalai.context.moe_context
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.parallel\_context
====================================
.. automodule:: colossalai.context.parallel_context
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.parallel\_mode
=================================
.. automodule:: colossalai.context.parallel_mode
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_1d
==============================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_1d
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_2d
==============================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_2d
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_2p5d
================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_2p5d
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_3d
==============================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_3d
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_data
================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_data
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_model
=================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_model
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_pipeline
====================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_pipeline
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_sequence
====================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_sequence
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.initializer\_tensor
==================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_tensor
:members:

View File

@ -1,5 +0,0 @@
colossalai.context.process\_group\_initializer.process\_group\_initializer
==========================================================================
.. automodule:: colossalai.context.process_group_initializer.process_group_initializer
:members:

View File

@ -1,20 +0,0 @@
colossalai.context.process\_group\_initializer
==============================================
.. automodule:: colossalai.context.process_group_initializer
:members:
.. toctree::
:maxdepth: 2
colossalai.context.process_group_initializer.initializer_1d
colossalai.context.process_group_initializer.initializer_2d
colossalai.context.process_group_initializer.initializer_2p5d
colossalai.context.process_group_initializer.initializer_3d
colossalai.context.process_group_initializer.initializer_data
colossalai.context.process_group_initializer.initializer_model
colossalai.context.process_group_initializer.initializer_pipeline
colossalai.context.process_group_initializer.initializer_sequence
colossalai.context.process_group_initializer.initializer_tensor
colossalai.context.process_group_initializer.process_group_initializer

View File

@ -1,11 +0,0 @@
colossalai.context.random
=========================
.. automodule:: colossalai.context.random
:members:
.. toctree::
:maxdepth: 2
colossalai.context.random.seed_manager

View File

@ -1,5 +0,0 @@
colossalai.context.random.seed\_manager
=======================================
.. automodule:: colossalai.context.random.seed_manager
:members:

View File

@ -1,21 +0,0 @@
colossalai.context
==================
.. automodule:: colossalai.context
:members:
.. toctree::
:maxdepth: 2
colossalai.context.process_group_initializer
colossalai.context.random
.. toctree::
:maxdepth: 2
colossalai.context.config
colossalai.context.moe_context
colossalai.context.parallel_context
colossalai.context.parallel_mode
colossalai.context.singleton_meta

View File

@ -1,5 +0,0 @@
colossalai.context.singleton\_meta
==================================
.. automodule:: colossalai.context.singleton_meta
:members:

View File

@ -1,5 +0,0 @@
colossalai.core
===============
.. automodule:: colossalai.core
:members:

View File

@ -1,5 +0,0 @@
colossalai.engine.gradient\_accumulation
========================================
.. automodule:: colossalai.engine.gradient_accumulation
:members:

View File

@ -1,11 +0,0 @@
colossalai.engine.gradient\_handler
===================================
.. automodule:: colossalai.engine.gradient_handler
:members:
.. toctree::
:maxdepth: 2
colossalai.engine.gradient_handler.utils

View File

@ -1,5 +0,0 @@
colossalai.engine.gradient\_handler.utils
=========================================
.. automodule:: colossalai.engine.gradient_handler.utils
:members:

View File

@ -1,12 +0,0 @@
colossalai.engine
=================
.. automodule:: colossalai.engine
:members:
.. toctree::
:maxdepth: 2
colossalai.engine.gradient_accumulation
colossalai.engine.gradient_handler
colossalai.engine.schedule

View File

@ -1,5 +0,0 @@
colossalai.engine.schedule
==========================
.. automodule:: colossalai.engine.schedule
:members:

View File

@ -1,5 +0,0 @@
colossalai.fx.passes.adding\_split\_node\_pass
==============================================
.. automodule:: colossalai.fx.passes.adding_split_node_pass
:members:

View File

@ -1,5 +0,0 @@
colossalai.fx.passes.meta\_info\_prop
=====================================
.. automodule:: colossalai.fx.passes.meta_info_prop
:members:

View File

@ -1,15 +0,0 @@
colossalai.fx.passes
====================
.. automodule:: colossalai.fx.passes
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.passes.adding_split_node_pass
colossalai.fx.passes.meta_info_prop
colossalai.fx.passes.shard_1d_pass
colossalai.fx.passes.split_module
colossalai.fx.passes.utils

View File

@ -1,5 +0,0 @@
colossalai.fx.passes.shard\_1d\_pass
====================================
.. automodule:: colossalai.fx.passes.shard_1d_pass
:members:

View File

@ -1,5 +0,0 @@
colossalai.fx.passes.split\_module
==================================
.. automodule:: colossalai.fx.passes.split_module
:members:

View File

@ -1,5 +0,0 @@
colossalai.fx.passes.utils
==========================
.. automodule:: colossalai.fx.passes.utils
:members:

View File

@ -1,5 +0,0 @@
colossalai.fx.proxy
===================
.. automodule:: colossalai.fx.proxy
:members:

View File

@ -1,17 +0,0 @@
colossalai.fx
=============
.. automodule:: colossalai.fx
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.passes
colossalai.fx.tracer
.. toctree::
:maxdepth: 2
colossalai.fx.proxy

View File

@ -1,11 +0,0 @@
colossalai.fx.tracer
====================
.. automodule:: colossalai.fx.tracer
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.tracer.tracer

View File

@ -1,5 +0,0 @@
colossalai.fx.tracer.tracer
===========================
.. automodule:: colossalai.fx.tracer.tracer
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.chunk
=======================
.. automodule:: colossalai.gemini.chunk
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.chunk\_mgr
============================
.. automodule:: colossalai.gemini.chunk_mgr
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.gemini\_context
=================================
.. automodule:: colossalai.gemini.gemini_context
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.gemini\_mgr
=============================
.. automodule:: colossalai.gemini.gemini_mgr
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.memory\_tracer.memory\_monitor
================================================
.. automodule:: colossalai.gemini.memory_tracer.memory_monitor
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.memory\_tracer.memstats\_collector
====================================================
.. automodule:: colossalai.gemini.memory_tracer.memstats_collector
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.memory\_tracer.model\_data\_memtracer
=======================================================
.. automodule:: colossalai.gemini.memory_tracer.model_data_memtracer
:members:

View File

@ -1,13 +0,0 @@
colossalai.gemini.memory\_tracer
================================
.. automodule:: colossalai.gemini.memory_tracer
:members:
.. toctree::
:maxdepth: 2
colossalai.gemini.memory_tracer.memory_monitor
colossalai.gemini.memory_tracer.memstats_collector
colossalai.gemini.memory_tracer.model_data_memtracer

View File

@ -1,11 +0,0 @@
colossalai.gemini.ophooks
=========================
.. automodule:: colossalai.gemini.ophooks
:members:
.. toctree::
:maxdepth: 2
colossalai.gemini.ophooks.utils

View File

@ -1,5 +0,0 @@
colossalai.gemini.ophooks.utils
===============================
.. automodule:: colossalai.gemini.ophooks.utils
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.paramhooks
============================
.. automodule:: colossalai.gemini.paramhooks
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.placement\_policy
===================================
.. automodule:: colossalai.gemini.placement_policy
:members:

View File

@ -1,27 +0,0 @@
colossalai.gemini
=================
.. automodule:: colossalai.gemini
:members:
.. toctree::
:maxdepth: 2
colossalai.gemini.memory_tracer
colossalai.gemini.ophooks
colossalai.gemini.paramhooks
.. toctree::
:maxdepth: 2
colossalai.gemini.chunk
colossalai.gemini.chunk_mgr
colossalai.gemini.gemini_context
colossalai.gemini.gemini_mgr
colossalai.gemini.placement_policy
colossalai.gemini.stateful_tensor
colossalai.gemini.stateful_tensor_container
colossalai.gemini.stateful_tensor_mgr
colossalai.gemini.tensor_placement_policy
colossalai.gemini.tensor_utils

View File

@ -1,5 +0,0 @@
colossalai.gemini.stateful\_tensor
==================================
.. automodule:: colossalai.gemini.stateful_tensor
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.stateful\_tensor\_container
=============================================
.. automodule:: colossalai.gemini.stateful_tensor_container
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.stateful\_tensor\_mgr
=======================================
.. automodule:: colossalai.gemini.stateful_tensor_mgr
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.tensor\_placement\_policy
===========================================
.. automodule:: colossalai.gemini.tensor_placement_policy
:members:

View File

@ -1,5 +0,0 @@
colossalai.gemini.tensor\_utils
===============================
.. automodule:: colossalai.gemini.tensor_utils
:members:

View File

@ -1,5 +0,0 @@
colossalai.global\_variables
============================
.. automodule:: colossalai.global_variables
:members:

View File

@ -1,5 +0,0 @@
colossalai.initialize
=====================
.. automodule:: colossalai.initialize
:members:

View File

@ -1,5 +0,0 @@
colossalai.kernel.cuda\_native.layer\_norm
==========================================
.. automodule:: colossalai.kernel.cuda_native.layer_norm
:members:

View File

@ -1,5 +0,0 @@
colossalai.kernel.cuda\_native.multihead\_attention
===================================================
.. automodule:: colossalai.kernel.cuda_native.multihead_attention
:members:

View File

@ -1,13 +0,0 @@
colossalai.kernel.cuda\_native
==============================
.. automodule:: colossalai.kernel.cuda_native
:members:
.. toctree::
:maxdepth: 2
colossalai.kernel.cuda_native.layer_norm
colossalai.kernel.cuda_native.multihead_attention
colossalai.kernel.cuda_native.scaled_softmax

View File

@ -1,5 +0,0 @@
colossalai.kernel.cuda\_native.scaled\_softmax
==============================================
.. automodule:: colossalai.kernel.cuda_native.scaled_softmax
:members:

View File

@ -1,5 +0,0 @@
colossalai.kernel.jit.bias\_dropout\_add
========================================
.. automodule:: colossalai.kernel.jit.bias_dropout_add
:members:

View File

@ -1,5 +0,0 @@
colossalai.kernel.jit.bias\_gelu
================================
.. automodule:: colossalai.kernel.jit.bias_gelu
:members:

View File

@ -1,5 +0,0 @@
colossalai.kernel.jit.option
============================
.. automodule:: colossalai.kernel.jit.option
:members:

View File

@ -1,13 +0,0 @@
colossalai.kernel.jit
=====================
.. automodule:: colossalai.kernel.jit
:members:
.. toctree::
:maxdepth: 2
colossalai.kernel.jit.bias_dropout_add
colossalai.kernel.jit.bias_gelu
colossalai.kernel.jit.option

View File

@ -1,11 +0,0 @@
colossalai.kernel
=================
.. automodule:: colossalai.kernel
:members:
.. toctree::
:maxdepth: 2
colossalai.kernel.cuda_native
colossalai.kernel.jit

View File

@ -1,5 +0,0 @@
colossalai.logging.logger
=========================
.. automodule:: colossalai.logging.logger
:members:

Some files were not shown because too many files have changed in this diff Show More