Skip to content
Snippets Groups Projects
Unverified Commit 8e9e61db authored by GehangZhang's avatar GehangZhang Committed by GitHub
Browse files

remove outdated doctest api and "@experimental_api" (#5564)


* change doctest code in abs.py

* del >>> flow.enable_eager_execution() in  modules/abs.py

* del @experimental_api

* del @experimental_api

* slove doctest not pass

* change abs.py for test

* refine acos

* remove enable_eager_execution() in oneflow/python

remove @experimental_api decorator for apis, except that ones
having same name with single client api.

* remove all import oneflow.experimental in doctest

* replace oneflow.experimental with oneflow in docstr

* reformat

* auto format by CI

* remove signle client twice api

* refine

* remove experimental of nn

* okokok

* remove experimental in test/modules and test/tensor

* remove experimental in test/dataloader

* remove experimental call in nn/modules

* remove experimental from nn/ framework/ test_utils

* remove experimental in functionalpy

* remove experimental of new merge

* skip fmod grad test

* remove experimental of fmod

* fix error when do multi case test on graph

* remove outdated rst files

* refine and add new rst files

* format

* revert test_fmod.py

* remove all experimental in python/nn dir (done!)

* remove experimental in test/graph

* add linagl

* refine rst

* refine scatter_nd

* refine oneflow.rst

* refine load_minst's docstring

add image.rst module.rst

refine rst files

* reformat

* remove Graph api

* fix file name

* fix index

Co-authored-by: default avatarYaoChi <later@usopp.net>
Co-authored-by: default avataroneflow-ci-bot <ci-bot@oneflow.org>
Co-authored-by: default avatarstrint <xiaoyulink@gmail.com>
Co-authored-by: default avatartsai <jackalcooper@gmail.com>
parent 3dbf6ae5
No related branches found
No related tags found
No related merge requests found
Showing
with 160 additions and 412 deletions
oneflow.advanced
===================================
Advanced features
----------------------------------
.. currentmodule:: oneflow.advanced
.. automodule:: oneflow.advanced
:members:
:imported-members:
oneflow.config
===================================
.. currentmodule:: oneflow.config
.. automodule:: oneflow.config
:members:
:imported-members:
oneflow.data
===================================
.. currentmodule:: oneflow.data
.. automodule:: oneflow.data
:members:
:imported-members:
oneflow.deprecated
===================================
Deprecated APIs
----------------------------------
.. currentmodule:: oneflow.deprecated
.. automodule:: oneflow.deprecated
:members:
:imported-members:
oneflow.distribute
===================================
.. currentmodule:: oneflow.distribute
.. automodule:: oneflow.distribute
:members:
:imported-members:
oneflow.env
===================================
.. currentmodule:: oneflow.env
.. automodule:: oneflow.env
:members:
:imported-members:
oneflow.experimental
===================================
Experimental features
----------------------------------
.. currentmodule:: oneflow.experimental
.. autofunction:: oneflow.experimental.nn.ReLU
.. autofunction:: oneflow.experimental.nn.ReLU6
.. autofunction:: oneflow.experimental.nn.LeakyReLU
.. autofunction:: oneflow.experimental.nn.Tanh
.. autofunction:: oneflow.experimental.tanh
.. autofunction:: oneflow.experimental.Tensor.tanh
.. autofunction:: oneflow.experimental.asin
.. autofunction:: oneflow.experimental.Tensor.asin
.. autofunction:: oneflow.experimental.arcsin
.. autofunction:: oneflow.experimental.Tensor.arcsin
.. autofunction:: oneflow.experimental.asinh
.. autofunction:: oneflow.experimental.Tensor.asinh
.. autofunction:: oneflow.experimental.sinh
.. autofunction:: oneflow.experimental.Tensor.sinh
.. autofunction:: oneflow.experimental.atan2
.. autofunction:: oneflow.experimental.Tensor.atan2
.. autofunction:: oneflow.experimental.softplus
.. autofunction:: oneflow.experimental.arcsinh
.. autofunction:: oneflow.experimental.Tensor.arcsinh
.. autofunction:: oneflow.experimental.nn.ELU
.. autofunction:: oneflow.experimental.nn.GELU
.. autofunction:: oneflow.experimental.gelu
.. autofunction:: oneflow.experimental.Tensor.gelu
.. autofunction:: oneflow.experimental.nn.Sigmoid
.. autofunction:: oneflow.experimental.sigmoid
.. autofunction:: oneflow.experimental.Tensor.sigmoid
.. autofunction:: oneflow.experimental.nn.Hardsigmoid
.. autofunction:: oneflow.experimental.softmax
.. autofunction:: oneflow.experimental.Tensor.softmax
.. autofunction:: oneflow.experimental.nn.LogSigmoid
.. autofunction:: oneflow.experimental.nn.Softplus
.. autofunction:: oneflow.experimental.nn.LogSoftmax
.. autofunction:: oneflow.experimental.nn.Mish
.. autofunction:: oneflow.experimental.mish
.. autofunction:: oneflow.experimental.Tensor.mish
.. autofunction:: oneflow.experimental.acosh
.. autofunction:: oneflow.experimental.Tensor.acosh
.. autofunction:: oneflow.experimental.arccosh
.. autofunction:: oneflow.experimental.Tensor.arccosh
.. autofunction:: oneflow.experimental.arange
.. autofunction:: oneflow.experimental.argwhere
.. autofunction:: oneflow.experimental.Tensor.argwhere
.. autofunction:: oneflow.experimental.argmax
.. autofunction:: oneflow.experimental.Tensor.argmax
.. autofunction:: oneflow.experimental.nn.BatchNorm1d
.. autofunction:: oneflow.experimental.nn.BatchNorm2d
.. autofunction:: oneflow.experimental.nn.InstanceNorm1d
.. autofunction:: oneflow.experimental.nn.InstanceNorm2d
.. autofunction:: oneflow.experimental.nn.InstanceNorm3d
.. autofunction:: oneflow.experimental.nn.LayerNorm
.. autofunction:: oneflow.experimental.cast
.. autofunction:: oneflow.experimental.Tensor.cast
.. autofunction:: oneflow.experimental.cat
.. autofunction:: oneflow.experimental.ones
.. autofunction:: oneflow.experimental.zeros
.. autofunction:: oneflow.experimental.zeros_like
.. autofunction:: oneflow.experimental.ones_like
.. autofunction:: oneflow.experimental.Tensor.new_ones
.. autofunction:: oneflow.experimental.nn.Module
.. autofunction:: oneflow.experimental.nn.Parameter
.. autofunction:: oneflow.experimental.nn.Sequential
.. autofunction:: oneflow.experimental.nn.ParameterList
.. autofunction:: oneflow.experimental.nn.ParameterDict
.. autofunction:: oneflow.experimental.nn.ModuleList
.. autofunction:: oneflow.experimental.nn.ModuleDict
.. autofunction:: oneflow.experimental.nn.Conv1d
.. autofunction:: oneflow.experimental.nn.Conv2d
.. autofunction:: oneflow.experimental.nn.ZeroPad2d
.. autofunction:: oneflow.experimental.nn.ReflectionPad2d
.. autofunction:: oneflow.experimental.nn.ReplicationPad2d
.. autofunction:: oneflow.experimental.nn.ConstantPad2d
.. autofunction:: oneflow.experimental.nn.ConstantPad3d
.. autofunction:: oneflow.experimental.nn.ConvTranspose2d
.. autofunction:: oneflow.experimental.nn.Dropout
.. autofunction:: oneflow.experimental.slice
.. autofunction:: oneflow.experimental.eq
.. autofunction:: oneflow.experimental.ne
.. autofunction:: oneflow.experimental.to
.. autofunction:: oneflow.experimental.Tensor.to
.. autofunction:: oneflow.experimental.equal
.. autofunction:: oneflow.experimental.Tensor.eq
.. autofunction:: oneflow.experimental.not_equal
.. autofunction:: oneflow.experimental.Tensor.ne
.. autofunction:: oneflow.experimental.exp
.. autofunction:: oneflow.experimental.Tensor.exp
.. autofunction:: oneflow.experimental.erf
.. autofunction:: oneflow.experimental.Tensor.erf
.. autofunction:: oneflow.experimental.erfc
.. autofunction:: oneflow.experimental.Tensor.erfc
.. autofunction:: oneflow.experimental.round
.. autofunction:: oneflow.experimental.Tensor.round
.. autofunction:: oneflow.experimental.Tensor.expand
.. autofunction:: oneflow.experimental.nn.Flatten
.. autofunction:: oneflow.experimental.flatten
.. autofunction:: oneflow.experimental.Tensor.flatten
.. autofunction:: oneflow.experimental.gt
.. autofunction:: oneflow.experimental.Tensor.gt
.. autofunction:: oneflow.experimental.ge
.. autofunction:: oneflow.experimental.Tensor.ge
.. autofunction:: oneflow.experimental.lt
.. autofunction:: oneflow.experimental.Tensor.lt
.. autofunction:: oneflow.experimental.le
.. autofunction:: oneflow.experimental.Tensor.le
.. autofunction:: oneflow.experimental.nn.Identity
.. autofunction:: oneflow.experimental.nn.PixelShuffle
.. autofunction:: oneflow.experimental.nn.Linear
.. autofunction:: oneflow.experimental.nn.CrossEntropyLoss
.. autofunction:: oneflow.experimental.nn.CTCLoss
.. autofunction:: oneflow.experimental.nn.L1Loss
.. autofunction:: oneflow.experimental.nn.BCELoss
.. autofunction:: oneflow.experimental.chunk
.. autofunction:: oneflow.experimental.Tensor.chunk
.. autofunction:: oneflow.experimental.nn.NLLLoss
.. autofunction:: oneflow.experimental.nn.KLDivLoss
.. autofunction:: oneflow.experimental.nn.MSELoss
.. autofunction:: oneflow.experimental.nn.MarginRankingLoss
.. autofunction:: oneflow.experimental.nn.BCEWithLogitsLoss
.. autofunction:: oneflow.experimental.nn.SmoothL1Loss
.. autofunction:: oneflow.experimental.masked_fill
.. autofunction:: oneflow.experimental.Tensor.masked_fill
.. autofunction:: oneflow.experimental.masked_select
.. autofunction:: oneflow.experimental.Tensor.masked_select
.. autofunction:: oneflow.experimental.sum
.. autofunction:: oneflow.experimental.Tensor.sum
.. autofunction:: oneflow.experimental.min
.. autofunction:: oneflow.experimental.Tensor.min
.. autofunction:: oneflow.experimental.max
.. autofunction:: oneflow.experimental.Tensor.max
.. autofunction:: oneflow.experimental.mul
.. autofunction:: oneflow.experimental.Tensor.mul
.. autofunction:: oneflow.experimental.mean
.. autofunction:: oneflow.experimental.Tensor.mean
.. autofunction:: oneflow.experimental.sub
.. autofunction:: oneflow.experimental.var
.. autofunction:: oneflow.experimental.Tensor.var
.. autofunction:: oneflow.experimental.Tensor.sub
.. autofunction:: oneflow.experimental.div
.. autofunction:: oneflow.experimental.Tensor.div
.. autofunction:: oneflow.experimental.reciprocal
.. autofunction:: oneflow.experimental.Tensor.reciprocal
.. autofunction:: oneflow.experimental.add
.. autofunction:: oneflow.experimental.Tensor.add
.. autofunction:: oneflow.experimental.Tensor.add_
.. autofunction:: oneflow.experimental.sign
.. autofunction:: oneflow.experimental.Tensor.sign
.. autofunction:: oneflow.experimental.sin
.. autofunction:: oneflow.experimental.Tensor.sin
.. autofunction:: oneflow.experimental.atan
.. autofunction:: oneflow.experimental.Tensor.atan
.. autofunction:: oneflow.experimental.arctan
.. autofunction:: oneflow.experimental.Tensor.arctan
.. autofunction:: oneflow.experimental.cos
.. autofunction:: oneflow.experimental.Tensor.cos
.. autofunction:: oneflow.experimental.log
.. autofunction:: oneflow.experimental.Tensor.log
.. autofunction:: oneflow.experimental.sqrt
.. autofunction:: oneflow.experimental.Tensor.sqrt
.. autofunction:: oneflow.experimental.square
.. autofunction:: oneflow.experimental.Tensor.square
.. autofunction:: oneflow.experimental.std
.. autofunction:: oneflow.experimental.Tensor.std
.. autofunction:: oneflow.experimental.pow
.. autofunction:: oneflow.experimental.Tensor.pow
.. autofunction:: oneflow.experimental.cosh
.. autofunction:: oneflow.experimental.Tensor.cosh
.. autofunction:: oneflow.experimental.acos
.. autofunction:: oneflow.experimental.Tensor.acos
.. autofunction:: oneflow.experimental.matmul
.. autofunction:: oneflow.experimental.Tensor.matmul
.. autofunction:: oneflow.experimental.bmm
.. autofunction:: oneflow.experimental.Tensor.bmm
.. autofunction:: oneflow.experimental.negative
.. autofunction:: oneflow.experimental.neg
.. autofunction:: oneflow.experimental.Tensor.negative
.. autofunction:: oneflow.experimental.nn.AvgPool1d
.. autofunction:: oneflow.experimental.nn.AvgPool2d
.. autofunction:: oneflow.experimental.nn.AvgPool3d
.. autofunction:: oneflow.experimental.nn.AdaptiveAvgPool1d
.. autofunction:: oneflow.experimental.nn.AdaptiveAvgPool2d
.. autofunction:: oneflow.experimental.nn.AdaptiveAvgPool3d
.. autofunction:: oneflow.experimental.adaptive_avg_pool1d
.. autofunction:: oneflow.experimental.adaptive_avg_pool2d
.. autofunction:: oneflow.experimental.adaptive_avg_pool3d
.. autofunction:: oneflow.experimental.nn.MaxPool1d
.. autofunction:: oneflow.experimental.nn.MaxPool2d
.. autofunction:: oneflow.experimental.nn.MaxPool3d
.. autofunction:: oneflow.experimental.repeat
.. autofunction:: oneflow.experimental.Tensor.repeat
.. autofunction:: oneflow.experimental.tile
.. autofunction:: oneflow.experimental.Tensor.tile
.. autofunction:: oneflow.experimental.fmod
.. autofunction:: oneflow.experimental.Tensor.fmod
.. autofunction:: oneflow.experimental.view
.. autofunction:: oneflow.experimental.Tensor.view
.. autofunction:: oneflow.experimental.reshape
.. autofunction:: oneflow.experimental.Tensor.reshape
.. autofunction:: oneflow.experimental.squeeze
.. autofunction:: oneflow.experimental.Tensor.squeeze
.. autofunction:: oneflow.experimental.flip
.. autofunction:: oneflow.experimental.Tensor.flip
.. autofunction:: oneflow.experimental.transpose
.. autofunction:: oneflow.experimental.Tensor.transpose
.. autofunction:: oneflow.experimental.unsqueeze
.. autofunction:: oneflow.experimental.Tensor.unsqueeze
.. autofunction:: oneflow.experimental.where
.. autofunction:: oneflow.experimental.Tensor.where
.. autofunction:: oneflow.experimental.gather
.. autofunction:: oneflow.experimental.Tensor.gather
.. autofunction:: oneflow.experimental.nn.Embedding
.. autofunction:: oneflow.experimental.Tensor.permute
.. autofunction:: oneflow.experimental.nn.Hardswish
.. autofunction:: oneflow.experimental.nn.PReLU
.. autofunction:: oneflow.experimental.nn.Hardtanh
.. autofunction:: oneflow.experimental.nn.functional.interpolate
.. autofunction:: oneflow.experimental.nn.Upsample
.. autofunction:: oneflow.experimental.nn.UpsamplingNearest2d
.. autofunction:: oneflow.experimental.nn.UpsamplingBilinear2d
.. autofunction:: oneflow.experimental.linalg.norm
.. autofunction:: oneflow.experimental.linalg.vector_norm
.. autofunction:: oneflow.experimental.linalg.matrix_norm
.. autofunction:: oneflow.experimental.Tensor.norm
.. autofunction:: oneflow.experimental.floor
.. autofunction:: oneflow.experimental.Tensor.floor
.. autofunction:: oneflow.experimental.addmm
.. autofunction:: oneflow.experimental.Tensor.addmm
.. autofunction:: oneflow.experimental.clamp
.. autofunction:: oneflow.experimental.Tensor.clamp
.. autofunction:: oneflow.experimental.clip
.. autofunction:: oneflow.experimental.Tensor.clip
.. autofunction:: oneflow.experimental.atanh
.. autofunction:: oneflow.experimental.Tensor.atanh
.. autofunction:: oneflow.experimental.arctanh
.. autofunction:: oneflow.experimental.Tensor.arctanh
.. autofunction:: oneflow.experimental.tan
.. autofunction:: oneflow.experimental.Tensor.tan
.. autofunction:: oneflow.experimental.log1p
.. autofunction:: oneflow.experimental.Tensor.log1p
.. autofunction:: oneflow.experimental.ceil
.. autofunction:: oneflow.experimental.Tensor.ceil
.. autofunction:: oneflow.experimental.expm1
.. autofunction:: oneflow.experimental.Tensor.expm1
.. autofunction:: oneflow.experimental.meshgrid
.. autofunction:: oneflow.experimental.topk
.. autofunction:: oneflow.experimental.Tensor.topk
.. autofunction:: oneflow.experimental.diag
.. autofunction:: oneflow.experimental.Tensor.diag
.. autofunction:: oneflow.experimental.nn.GroupNorm
.. autofunction:: oneflow.experimental.gather_nd
.. autofunction:: oneflow.experimental.scatter_nd
.. autofunction:: oneflow.experimental.nn.image.flip
.. autofunction:: oneflow.experimental.tensor_buffer_to_tensor
.. autofunction:: oneflow.experimental.tensor_to_tensor_buffer
.. autofunction:: oneflow.experimental.Tensor.type_as
.. autofunction:: oneflow.experimental.Tensor.long
.. autofunction:: oneflow.experimental.bernoulli
.. autofunction:: oneflow.experimental.in_top_k
.. autofunction:: oneflow.experimental.Tensor.in_top_k
\ No newline at end of file
oneflow.image
===================================
Image processing
----------------------------------
.. currentmodule:: oneflow.image
.. automodule:: oneflow.image
:members:
:imported-members:
oneflow.nn.image
======================================
Image operations for neural networks
--------------------------------------
.. currentmodule:: oneflow.nn.image
.. automodule:: oneflow.nn.image
:members: ImageBatchAlign,
ImageDecode,
ImageFlip,
ImageNormalize,
ImageResize,
Resize,
batch_align,
decode,
flip,
normalize
\ No newline at end of file
......@@ -12,28 +12,12 @@ OneFlow API Reference
:caption: OneFlow Python API
oneflow
env
config
optimizer
losses
math
tensor
nn
layers
data
distribute
advanced
typing
tensorrt
deprecated
experimental
module
F
scope
sysconfig
random
system
regularizers
linalg
image
train
optim
......
oneflow.layers
===================================
Operators with variables
----------------------------------
.. currentmodule:: oneflow.layers
.. automodule:: oneflow.layers
:members:
:imported-members:
oneflow.linalg
===================================
OneFlow linear algebra operations.
----------------------------------
.. currentmodule:: oneflow.linalg
.. autofunction:: oneflow.linalg.matrix_norm
.. autofunction:: oneflow.linalg.norm
.. autofunction:: oneflow.linalg.vector_norm
oneflow.losses
===================================
Operators for neural networks
----------------------------------
.. currentmodule:: oneflow.losses
.. automodule:: oneflow.losses
:members:
:imported-members:
oneflow.math
===================================
.. currentmodule:: oneflow.math
.. automodule:: oneflow.math
:members:
:imported-members:
oneflow.nn.Module
================================================
Module and its containers for neural networks
---------------------------------------------------
.. currentmodule:: oneflow.nn
.. autoclass:: oneflow.nn.Module
:members:
.. autoclass:: oneflow.nn.ModuleDict
:members:
.. autoclass:: oneflow.nn.ModuleList
:members:
......@@ -4,5 +4,75 @@ Operators for neural networks
----------------------------------
.. currentmodule:: oneflow.nn
.. automodule:: oneflow.nn
:members:
:imported-members:
:members: AdaptiveAvgPool1d,
AdaptiveAvgPool2d,
AdaptiveAvgPool3d,
AvgPool1d,
AvgPool2d,
AvgPool3d,
BCELoss,
BCEWithLogitsLoss,
BatchNorm1d,
BatchNorm2d,
COCOReader,
CTCLoss,
CoinFlip,
ConstantPad2d,
ConstantPad3d,
Conv1d,
Conv2d,
ConvTranspose2d,
CropMirrorNormalize,
CrossEntropyLoss,
Dropout,
ELU,
Embedding,
Flatten,
GELU,
GroupNorm,
Hardsigmoid,
Hardswish,
Hardtanh,
Identity,
InstanceNorm1d,
InstanceNorm2d,
InstanceNorm3d,
KLDivLoss,
L1Loss,
LayerNorm,
LeakyReLU,
Linear,
LogSigmoid,
LogSoftmax,
MSELoss,
MarginRankingLoss,
MaxPool1d,
MaxPool2d,
MaxPool3d,
Mish,
NLLLoss,
OFRecordImageDecoder,
OFRecordImageDecoderRandomCrop,
OfrecordRawDecoder,
OfrecordReader,
PReLU,
Parameter,
ParameterDict,
ParameterList,
PixelShuffle,
PixelShufflev2,
ReLU,
ReLU6,
ReflectionPad2d,
ReplicationPad2d,
Sequential,
Sigmoid,
SmoothL1Loss,
Softmax,
Softplus,
Tanh,
Upsample,
UpsamplingBilinear2d,
UpsamplingNearest2d,
ZeroPad2d,
ctc_greedy_decoder
oneflow
===================================
oneflow
----------------------------------
.. currentmodule:: oneflow
.. automodule:: oneflow
:members:
:imported-members:
Types
----------------------------------
oneflow.double
oneflow.float
oneflow.float32
oneflow.float64
oneflow.int32
oneflow.int64
oneflow.int8
:members: advanced,
argsort,
argwhere,
clamp,
clip,
diag,
enable_eager_execution,
expand,
flatten,
function_config,
gather,
gather_nd,
in_top_k,
load,
masked_fill,
matmul,
ones,
ones_like,
repeat,
reshape,
save,
saved_model,
scatter_nd,
slice,
slice_update,
sort,
squeeze,
stack,
tensor,
to,
transpose,
where,
zeros,
zeros_like
.. autofunction:: oneflow.data.load_mnist(train_batch_size=100, test_batch_size=100, data_format='NCHW')
\ No newline at end of file
......@@ -3,12 +3,16 @@ oneflow.optim
Optimizers
----------------------------------
.. currentmodule:: oneflow.optim
.. autofunction:: oneflow.experimental.optim.Optimizer.zero_grad
.. autofunction:: oneflow.experimental.optim.Adam
.. autofunction:: oneflow.experimental.optim.AdamW
.. autofunction:: oneflow.experimental.optim.RMSprop
.. autofunction:: oneflow.experimental.optim.SGD
.. autofunction:: oneflow.experimental.optim.lr_scheduler.CosineAnnealingLR
.. autofunction:: oneflow.experimental.optim.lr_scheduler.StepLR
.. autofunction:: oneflow.experimental.optim.lr_scheduler.LambdaLR
.. automodule:: oneflow.optim
:members: Adam,
AdamW,
Optimizer,
RMSprop,
SGD,
lr_scheduler
.. automodule:: oneflow.optim.lr_scheduler
:members: CosineAnnealingLR,
LambdaLR,
LrScheduler,
StepLR
oneflow.optimizer
===================================
Optimizers
----------------------------------
.. currentmodule:: oneflow.optimizer
.. automodule:: oneflow.optimizer
:members:
:imported-members:
.. automodule:: oneflow.optimizer.warmup
:members:
:imported-members:
.. automodule:: oneflow.optimizer.grad_clipping
:members:
:imported-members:
\ No newline at end of file
oneflow.random
===================================
Random
----------------------------------
.. currentmodule:: oneflow.random
.. automodule:: oneflow.random
:members:
:imported-members:
oneflow.regularizers
===================================
Regularizers
----------------------------------
.. currentmodule:: oneflow.regularizers
.. automodule:: oneflow.regularizers
:members:
:imported-members:
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment