Skip to content
This repository was archived by the owner on Jun 3, 2025. It is now read-only.

Commit 4387a23

Browse files
markurtzmarkurtz
authored
Update api docs for 0.3 release (#208)
* Update api docs for 0.3 release * run make style
1 parent 35196e0 commit 4387a23

18 files changed

+548
-0
lines changed

‎docs/api/sparseml.deepsparse.framework.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.deepsparse.framework package
17+
=====================================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.deepsparse.framework.info module
23+
-----------------------------------------
24+
25+
.. automodule:: sparseml.deepsparse.framework.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.deepsparse.framework
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.deepsparse.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.deepsparse package
17+
===========================
18+
19+
Subpackages
20+
-----------
21+
22+
.. toctree::
23+
:maxdepth: 4
24+
25+
sparseml.deepsparse.framework
26+
sparseml.deepsparse.sparsification
27+
28+
Submodules
29+
----------
30+
31+
sparseml.deepsparse.base module
32+
-------------------------------
33+
34+
.. automodule:: sparseml.deepsparse.base
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: sparseml.deepsparse
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/api/sparseml.deepsparse.sparsification.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.deepsparse.sparsification package
17+
==========================================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.deepsparse.sparsification.info module
23+
----------------------------------------------
24+
25+
.. automodule:: sparseml.deepsparse.sparsification.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.deepsparse.sparsification
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.framework.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.framework package
17+
==========================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.framework.info module
23+
------------------------------
24+
25+
.. automodule:: sparseml.framework.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.framework
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.keras.framework.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.keras.framework package
17+
================================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.keras.framework.info module
23+
------------------------------------
24+
25+
.. automodule:: sparseml.keras.framework.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.keras.framework
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.keras.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,23 @@ Subpackages
2323
:maxdepth: 4
2424

2525
sparseml.keras.datasets
26+
sparseml.keras.framework
2627
sparseml.keras.models
2728
sparseml.keras.optim
29+
sparseml.keras.sparsification
2830
sparseml.keras.utils
2931

32+
Submodules
33+
----------
34+
35+
sparseml.keras.base module
36+
--------------------------
37+
38+
.. automodule:: sparseml.keras.base
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
3043
Module contents
3144
---------------
3245

‎docs/api/sparseml.keras.sparsification.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.keras.sparsification package
17+
=====================================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.keras.sparsification.info module
23+
-----------------------------------------
24+
25+
.. automodule:: sparseml.keras.sparsification.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.keras.sparsification
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.onnx.framework.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.onnx.framework package
17+
===============================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.onnx.framework.info module
23+
-----------------------------------
24+
25+
.. automodule:: sparseml.onnx.framework.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.onnx.framework
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎docs/api/sparseml.onnx.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,22 @@ Subpackages
2222
.. toctree::
2323
:maxdepth: 4
2424

25+
sparseml.onnx.framework
2526
sparseml.onnx.optim
27+
sparseml.onnx.sparsification
2628
sparseml.onnx.utils
2729

30+
Submodules
31+
----------
32+
33+
sparseml.onnx.base module
34+
-------------------------
35+
36+
.. automodule:: sparseml.onnx.base
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
2841
Module contents
2942
---------------
3043

‎docs/api/sparseml.onnx.sparsification.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
16+
sparseml.onnx.sparsification package
17+
====================================
18+
19+
Submodules
20+
----------
21+
22+
sparseml.onnx.sparsification.info module
23+
----------------------------------------
24+
25+
.. automodule:: sparseml.onnx.sparsification.info
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Module contents
31+
---------------
32+
33+
.. automodule:: sparseml.onnx.sparsification
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

0 commit comments

Comments
 (0)