mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 12:54:11 +08:00
[Caffe2] Remove Caffe2 documentation (#130089)
Due to the removal of Caffe2 code. Pull Request resolved: https://github.com/pytorch/pytorch/pull/130089 Approved by: https://github.com/r-barnes, https://github.com/albanD
This commit is contained in:
cyy
PyTorch MergeBot
@ -208,7 +208,6 @@ endif()
|
||||
include(CMakeDependentOption)
|
||||
option(ATEN_NO_TEST "Do not build ATen test binaries" OFF)
|
||||
option(BUILD_BINARY "Build C++ binaries" OFF)
|
||||
option(BUILD_DOCS "Build Caffe2 documentation" OFF)
|
||||
option(BUILD_CUSTOM_PROTOBUF
|
||||
"Build and use Caffe2's own protobuf under third_party" ON)
|
||||
option(BUILD_PYTHON "Build Python binaries" ON)
|
||||
@ -1222,45 +1221,6 @@ endif()
|
||||
add_subdirectory(c10)
|
||||
add_subdirectory(caffe2)
|
||||
|
||||
# --[ Documentation
|
||||
if(BUILD_DOCS)
|
||||
# check if Doxygen is installed
|
||||
find_package(Doxygen)
|
||||
if(DOXYGEN_FOUND)
|
||||
message("Generating documentation")
|
||||
|
||||
set(DOXYGEN_C_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/caffe2/.Doxyfile-c)
|
||||
set(DOXYGEN_C_OUT ${CMAKE_CURRENT_SOURCE_DIR}/docs/caffe2/Doxyfile-c)
|
||||
set(DOXYGEN_P_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/caffe2/.Doxyfile-python)
|
||||
set(DOXYGEN_P_OUT ${CMAKE_CURRENT_SOURCE_DIR}/docs/caffe2/Doxyfile-python)
|
||||
|
||||
if(EXISTS ${CMAKE_CURRENT_BINARY_DIR}/docs)
|
||||
file(REMOVE_RECURSE ${CMAKE_CURRENT_BINARY_DIR}/docs)
|
||||
endif()
|
||||
|
||||
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs)
|
||||
configure_file(${DOXYGEN_C_IN} ${DOXYGEN_C_OUT} @ONLY)
|
||||
configure_file(${DOXYGEN_P_IN} ${DOXYGEN_P_OUT} @ONLY)
|
||||
|
||||
add_custom_target(
|
||||
doc_doxygen_c ALL
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_C_OUT}
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
||||
COMMENT "Generating C++ API documentation with Doxygen"
|
||||
VERBATIM)
|
||||
|
||||
add_custom_target(
|
||||
doc_doxygen_python ALL
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_P_OUT}
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
||||
COMMENT "Generating Python API documentation with Doxygen"
|
||||
VERBATIM)
|
||||
else()
|
||||
message(
|
||||
FATAL_ERROR "Doxygen needs to be installed to generate the documentation")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# ---[ CMake related files Uninistall option.
|
||||
if(NOT TARGET caffe2_uninstall)
|
||||
configure_file(
|
||||
|
||||
@ -36,7 +36,6 @@ function(caffe2_print_configuration_summary)
|
||||
message(STATUS " Protobuf includes : ${PROTOBUF_INCLUDE_DIRS}")
|
||||
message(STATUS " Protobuf libraries : ${PROTOBUF_LIBRARIES}")
|
||||
endif()
|
||||
message(STATUS " BUILD_DOCS : ${BUILD_DOCS}")
|
||||
message(STATUS " BUILD_PYTHON : ${BUILD_PYTHON}")
|
||||
if(${BUILD_PYTHON})
|
||||
message(STATUS " Python version : ${Python_VERSION}")
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB |
@ -1,73 +0,0 @@
|
||||
# Doxygen Notes
|
||||
|
||||
Doxygen seems to behave better if the processing between C++ and Python was split up. This is why there are two different links to cover each API.
|
||||
|
||||
C++ API docs work out of the box with the Caffe2 source code. Python docs require “python blocks (http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#pythonblocks)” which are (often) currently missing in the Python code.
|
||||
|
||||
The Python script called “process.py” that resides in the /docs folder is to prepare the docs by looking for the block and if it doesn't exist prepend and customize the python blocks section with the module's path (e.g. Module caffe2.python.examples.char_rnn). It was noted that you need to delete the previous version of docs when you regenerate the docs or else things get messy, so the script deals with that as well.
|
||||
|
||||
The doxygen customization includes these files in the doxygen folder:
|
||||
|
||||
* header.html - logo links back to the main docs page
|
||||
* footer.html - includes the Facebook OSS footer
|
||||
* stylesheet.css - doxygen's default CSS; tweaked to fix formatting problems with the custom logo, header, and footer
|
||||
* main.css - copied from the caffe2ai CSS, so this should be refreshed after the design changes (this overrides/extends stylesheet.css)
|
||||
|
||||
It also extracts info from markdown files found in the source tree. A legacy installation file was in the /docs folder and this was removed. These file show up in the top navigation under “Related Pages”.
|
||||
|
||||
The flow to create the API documents is simple now:
|
||||
|
||||
1. Run /caffe2_root/docs/process.py
|
||||
2. (TODO automatically) Copy the doxygen-c and doxygen-python folders created by the script to the gh-pages branch.
|
||||
|
||||
Settings that were customized:
|
||||
|
||||
OPTIMIZE_OUTPUT_JAVA - turned on for Python config, off for C++ config
|
||||
USE_MDFILE_AS_MAINPAGE - use to flag a markdown file for the mainpage
|
||||
EXTRACT_ALL
|
||||
QUIET
|
||||
WARN_IF_UNDOCUMENTED
|
||||
FILE_PATTERNS
|
||||
DOT_MULTI_TARGETS = YES
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
QUIET = YES
|
||||
SOURCE_BROWSER = YES
|
||||
VERBATIM_HEADERS = NO
|
||||
SHOW_NAMESPACES = NO for C++ config
|
||||
|
||||
Not using this (was in old config file, but seems to be for Latex):
|
||||
EXTRA_PACKAGES = amsmath \
|
||||
amsfonts \
|
||||
xr
|
||||
|
||||
### NOTE / TODO:
|
||||
|
||||
useful for xcode, currently off
|
||||
GENERATE_DOCSET = NO
|
||||
|
||||
Look at search engine integration, xml output, etc
|
||||
EXTERNAL_SEARCH = YES
|
||||
|
||||
### Other Notes
|
||||
|
||||
To achieve better output in the Python docs:
|
||||
http://stackoverflow.com/questions/7690220/how-to-document-python-function-parameter-types
|
||||
|
||||
Swap this kind of formatting into py files:
|
||||
|
||||
```
|
||||
def my_method(x, y):"""!
|
||||
my_method description
|
||||
|
||||
@type x: int
|
||||
@param x: An integer
|
||||
|
||||
@type y: int|string
|
||||
@param y: An integer or string
|
||||
|
||||
@rtype: string
|
||||
@return: Returns a sentence with your variables in it
|
||||
"""return "Hello World! %s, %s" % (x,y)
|
||||
```
|
||||
|
||||
Note that the bang (!) is added after the opening comment """! - this seems to do the trick and the remaining comments will be nicely parsed by Doxygen.
|
||||
@ -1,197 +0,0 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.14 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="no" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||
<tab type="globals" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
<tab type="user" url="/doxygen-c/html/classes.html" title="C++ API"/>
|
||||
<tab type="user" url="/doxygen-python/html/annotated.html" title="Python API"/>
|
||||
<tab type="user" url="https://github.com/caffe2/caffe2" title="GitHub"/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<classes visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
@ -1,197 +0,0 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.14 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="no" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||
<tab type="globals" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
<tab type="user" url="/doxygen-c/html/classes.html" title="C++ API"/>
|
||||
<tab type="user" url="/doxygen-python/html/annotated.html" title="Python API"/>
|
||||
<tab type="user" url="https://github.com/caffe2/caffe2" title="GitHub"/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<classes visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
@ -1,204 +0,0 @@
|
||||
# Docs Notes
|
||||
|
||||
Caffe2 docs are split up into three areas:
|
||||
|
||||
1) Caffe2.ai website: this comes from the gh-pages branch via the markdown files found in `gh-pages:caffe2/_docs`; you can run this locally with jekyll and push changes directly to github if you're a contributor without the need for a PR
|
||||
2) Operators catalogue: this comes from scripts in the master branch found in `master:caffe2/python/docs`; running `github_generator > operators-catalogue.md` and moving this md file to `gh-pages:caffe2/_docs` manually is currently the process
|
||||
3) C++ API and Python API Doxygen docs: these are generated by Doxygen manually or by using `master:caffe2/docs/process.py` and copied to the `gh-pages:caffe2/doxygen-c` and `gh-pages:caffe2/doxygen-python` folders
|
||||
|
||||
## Docs Maintenance Setup
|
||||
|
||||
You need to have access to the master branch to generate the docs from source and you need access to the gh-pages branch to publish them. Since you often want the files simultaneously and since the folder structures between master and gh-pages differ so greatly, it is advised to clone each branch to different folders. Otherwise if you switch back and forth between gh-pages and master within the same local repo, you'll end up seeing folders in branches that shouldn't be there, and it can get really confusing once you start running Doxygen and generating thousands of new files.
|
||||
|
||||
```
|
||||
cd ~
|
||||
git clone https://github.com/caffe2/caffe2.git c2master && cd c2master && git checkout master
|
||||
cd ~
|
||||
git clone https://github.com/caffe2/caffe2.git c2docs && cd c2docs && git checkout gh-pages
|
||||
```
|
||||
|
||||
## Generating Operator Catalog
|
||||
|
||||
To update the operator catalog, a script must be run on the master branch and copied to your docs checkout. To trigger this use:
|
||||
|
||||
1. `cd ~/c2master`
|
||||
2. `python caffe2/python/docs/github.py ~/c2docs/_docs/operators-catalogue.md`
|
||||
|
||||
## Generating API Docs with Doxygen
|
||||
|
||||
Support for generating the docs has been included in the CMake build process, but it is turned off by default. To trigger building of the docs use:
|
||||
|
||||
1. `cd ~/c2master`
|
||||
2. `mkdir build && cd build`
|
||||
3. `cmake -DBUILD_DOCS=ON .. && make`
|
||||
|
||||
This will create a docs subfolder in the build folder. You can launch either API's web page docs by opening the index.html file found at `build/docs/doxygen-c/html/index.html` or `build/docs/doxygen-python/html/index.html`.
|
||||
|
||||
To push to caffe2.ai, copy these from the build directory to your docs checkout:
|
||||
1. `cd ~/c2docs`
|
||||
2. `rm -rf doxygen-c`
|
||||
3. `rm -rf doxygen-python`
|
||||
4. `cp -r ~/c2master/build/docs/doxygen-c .`
|
||||
5. `cp -r ~/c2master/build/docs/doxygen-python .`
|
||||
6. `git add -A .`
|
||||
|
||||
### Install Doxygen
|
||||
|
||||
You will need to install Doxygen to build Caffe2 with the API docs.
|
||||
|
||||
#### MacOS X
|
||||
|
||||
1. Press Command+Space and type Terminal and press enter/return key.
|
||||
2. Run in Terminal app:
|
||||
`ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null`
|
||||
and press enter/return key. Wait for the command to finish.
|
||||
3. Run:
|
||||
`brew install doxygen`
|
||||
|
||||
Other operating systems' installation instructions can be found on the [Doxygen website](https://www.stack.nl/~dimitri/doxygen/manual/install.html).
|
||||
|
||||
### Doxygen Notes
|
||||
|
||||
Doxygen seems to behave better if the processing between C++ and Python was split up. This is why there are two different links to cover each API.
|
||||
|
||||
C++ API docs work out of the box with the Caffe2 source code. Python docs require “[python blocks](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#pythonblocks)” which are (often) currently missing in the Python code.
|
||||
|
||||
The Doxygen customization includes these files in the doxygen folder:
|
||||
|
||||
* header.html - logo links back to the main docs page
|
||||
* footer.html - includes the Facebook OSS footer
|
||||
* stylesheet.css - Doxygen's default CSS; tweaked to fix formatting problems with the custom logo, header, and footer
|
||||
* main.css - copied from the caffe2ai CSS, so this should be refreshed after the design changes (this overrides/extends stylesheet.css)
|
||||
|
||||
It also extracts info from markdown files found in the source tree. A legacy installation file was in the /docs folder and this was removed. These file show up in the top navigation under “Related Pages”.
|
||||
|
||||
### Scripts for Adding the Doxygen Preamble and Publishing the Docs
|
||||
|
||||
Some of the Python files may be missing the preamble Doxygen needs to generate docs, so the Python script called “process.py” that resides in the /docs folder is used to prepare the docs by looking for the block and if it doesn't exist prepend and customize the python blocks section with the module's path (e.g. Module caffe2.python.examples.char_rnn). It was noted that you need to delete the previous version of docs when you regenerate the docs or else things get messy, so the script deals with that as well.
|
||||
|
||||
To manually create API documents, go to your master checkout:
|
||||
|
||||
1. `cd c2master`
|
||||
2. `cd docs && python process.py`
|
||||
|
||||
If you want to push these to caffe2.ai, go to your docs checkout:
|
||||
1. `cd c2docs`
|
||||
2. Copy the files generated in build/docs to your gh-pages branch, commit, and push.
|
||||
3. `doxygen-c` and `doxygen-python` both go in the root folder of `gh-pages`
|
||||
4. `operators-catalogue.md` goes in `_docs`
|
||||
|
||||
### Running Doxygen Manually
|
||||
|
||||
It may be beneficial to run Doxygen on your own and not try to inject the preamble. Just note that any files without a preamble will not show up in the docs.
|
||||
|
||||
To do this, make sure you have doxygen installed and from the master branch root run:
|
||||
|
||||
```
|
||||
doxygen .Doxyfile-python
|
||||
doxygen .Doxyfile-c
|
||||
```
|
||||
`.Doxyfile-python` and `.Doxyfile-c` are config files that are optimized for each code format. They each use Doxygen's config for `OUTPUT_DIRECTORY` which is set to docs/doxygen-python or docs/doxygen-c respectively.
|
||||
|
||||
### Publishing the New Doxygen Files
|
||||
|
||||
You will not be able to `git push` to `gh-pages` until you have switched auth methods to SSH:
|
||||
|
||||
```
|
||||
git remote set-url origin git@github.com:caffe2/caffe2.git
|
||||
```
|
||||
|
||||
Doxygen will tend to change and remove a lot of file and a simple copy can leave files behind that shouldn't be there anymore, so it is advised to delete the old doxygen-c and doxygen-python folders first. Copy the new files to the root folder of the gh-pages branch, making sure before you commit, you `git add` the deleted files, the new files, and the modified files. Then `git push` will push these changes without the need for a PR.
|
||||
|
||||
### Maintaining the Doxygen Configs
|
||||
|
||||
Each of the config files is customized differently and these changes are mentioned further below. A more common update though is the `EXCLUDE` config which is used to exclude whole directories and individual files. As new folders and special files are added it may make sense to update this so Python's API isn't including a bunch of new C++ info. You also end up with some third party files that you probably don't want to include in the docs.
|
||||
`FILE_PATTERNS` is supposed to prevent the Python & C++ docs from getting mixed up, but a combination of `FILE_PATTERNS` and `EXCLUDE` seems have worked best.
|
||||
|
||||
Settings that were customized:
|
||||
|
||||
OPTIMIZE_OUTPUT_JAVA - turned on for Python config, off for C++ config
|
||||
USE_MDFILE_AS_MAINPAGE - use to flag a markdown file for the mainpage
|
||||
EXTRACT_ALL
|
||||
QUIET
|
||||
WARN_IF_UNDOCUMENTED
|
||||
FILE_PATTERNS
|
||||
DOT_MULTI_TARGETS = YES
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
QUIET = YES
|
||||
SOURCE_BROWSER = YES
|
||||
VERBATIM_HEADERS = NO
|
||||
SHOW_NAMESPACES = NO for C++ config
|
||||
|
||||
Not using this (was in old config file, but seems to be for Latex):
|
||||
EXTRA_PACKAGES = amsmath \
|
||||
amsfonts \
|
||||
xr
|
||||
|
||||
## Caffe2.ai
|
||||
|
||||
For more info on contributing to Caffe2.ai, take a look at [CONTRIBUTING.md](https://github.com/caffe2/caffe2/blob/gh-pages/CONTRIBUTING.md) found in the root of the gh-pages branch. This will help you setup jekyll locally so you can make your edits and test your changes. The most commonly updated areas are the markdown files in the `_docs` folder as well as the navigation structure (to add things to the sidebar) which is found at `_data/nav_docs.yml`. Each markdown file is required to have a header and if you wish for the markdown doc to appear as an item in the navigation the `id` in the yml file is equivalent to the `docid` in the markdown file.
|
||||
|
||||
For example in the Applications of Deep Learning markdown file we have:
|
||||
|
||||
```
|
||||
---
|
||||
docid: applications-of-deep-learning
|
||||
title: Applications of Deep Learning
|
||||
layout: docs
|
||||
permalink: /docs/applications-of-deep-learning.html
|
||||
---
|
||||
```
|
||||
|
||||
In the `_data/nav_docs.yml` file we have:
|
||||
|
||||
```
|
||||
- title: Quick Start
|
||||
items:
|
||||
- id: getting-started
|
||||
- id: learn-more
|
||||
- id: caffe-migration
|
||||
- title: Learn
|
||||
items:
|
||||
- id: applications-of-deep-learning
|
||||
- id: operators
|
||||
- id: mobile-integration
|
||||
...(more navigation here)...
|
||||
```
|
||||
|
||||
To link up the `docid: applications-of-deep-learning` markdown file to the navigation we have it listed under `- title: Learn` then under `items:` and then `- id: applications-of-deep-learning` using `id` instead of `docid`. The order in the yml file is how it is displayed in the browser, and it will pull the `title` from the markdown file's header and display that as the H1 for the page. In this example, `title: Applications of Deep Learning` shows "Applications of Deep Learning" at the top in H1 format, so in your markdown file there's no need to add your own H1 or single hash title for the page.
|
||||
|
||||
### TODO:
|
||||
|
||||
In the future it would be ideal to expand these Operator Catalogue scripts to provide documentation for all C++ operators and Python modules. Instead it focuses on a subset of operators only, so in the interim Doxygen is used to backfill this gap.
|
||||
|
||||
Additionally, the operators-catalogue.md file that is generated is quite large and difficult to search, so breaking it up and adding categories to the Schema of the operators would be very helpful.
|
||||
|
||||
To achieve better output in the Doxygen Python docs:
|
||||
http://stackoverflow.com/questions/7690220/how-to-document-python-function-parameter-types
|
||||
|
||||
Swap this kind of formatting into py files:
|
||||
|
||||
```
|
||||
def my_method(x, y):"""!
|
||||
my_method description
|
||||
|
||||
@type x: int
|
||||
@param x: An integer
|
||||
|
||||
@type y: int|string
|
||||
@param y: An integer or string
|
||||
|
||||
@rtype: string
|
||||
@return: Returns a sentence with your variables in it
|
||||
"""return "Hello World! %s, %s" % (x,y)
|
||||
```
|
||||
|
||||
Note that the bang (!) is added after the opening comment """! - this seems to do the trick and the remaining comments will be nicely parsed by Doxygen.
|
||||
|
||||
### Other Notes
|
||||
|
||||
Useful for Xcode, currently off
|
||||
GENERATE_DOCSET = NO
|
||||
|
||||
Look at search engine integration, xml output, etc
|
||||
EXTERNAL_SEARCH = YES
|
||||
@ -1,55 +0,0 @@
|
||||
<!-- HTML footer for doxygen 1.8.14-->
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
|
||||
</a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
<div class="footerContainer">
|
||||
<div id="footer_wrap" class="wrapper footerWrapper">
|
||||
<div class="footerBlocks">
|
||||
<div id="fb_oss" class="footerSection fbOpenSourceFooter">
|
||||
<svg class="facebookOSSLogoSvg" viewBox="0 0 1133.9 1133.9" x="0px" y="0px" height=50 width=50>
|
||||
<g>
|
||||
<path class="logoRing outerRing" d="M 498.3 3.7 c 153.6 88.9 307.3 177.7 461.1 266.2 c 7.6 4.4 10.3 9.1 10.3 17.8 c -0.3 179.1 -0.2 358.3 0 537.4 c 0 8.1 -2.4 12.8 -9.7 17.1 c -154.5 88.9 -308.8 178.1 -462.9 267.5 c -9 5.2 -15.5 5.3 -24.6 0.1 c -153.9 -89.2 -307.9 -178 -462.1 -266.8 C 3 838.8 0 833.9 0 825.1 c 0.3 -179.1 0.2 -358.3 0 -537.4 c 0 -8.6 2.6 -13.6 10.2 -18 C 164.4 180.9 318.4 92 472.4 3 C 477 -1.5 494.3 -0.7 498.3 3.7 Z M 48.8 555.3 c 0 79.9 0.2 159.9 -0.2 239.8 c -0.1 10 3 15.6 11.7 20.6 c 137.2 78.8 274.2 157.8 411 237.3 c 9.9 5.7 17 5.7 26.8 0.1 c 137.5 -79.8 275.2 -159.2 412.9 -238.5 c 7.4 -4.3 10.5 -8.9 10.5 -17.8 c -0.3 -160.2 -0.3 -320.5 0 -480.7 c 0 -8.8 -2.8 -13.6 -10.3 -18 C 772.1 218 633.1 137.8 494.2 57.4 c -6.5 -3.8 -11.5 -4.5 -18.5 -0.5 C 336.8 137.4 197.9 217.7 58.8 297.7 c -7.7 4.4 -10.2 9.2 -10.2 17.9 C 48.9 395.5 48.8 475.4 48.8 555.3 Z" />
|
||||
<path class="logoRing middleRing" d="M 184.4 555.9 c 0 -33.3 -1 -66.7 0.3 -100 c 1.9 -48 24.1 -86 64.7 -110.9 c 54.8 -33.6 110.7 -65.5 167 -96.6 c 45.7 -25.2 92.9 -24.7 138.6 1 c 54.4 30.6 108.7 61.5 162.2 93.7 c 44 26.5 67.3 66.8 68 118.4 c 0.9 63.2 0.9 126.5 0 189.7 c -0.7 50.6 -23.4 90.7 -66.6 116.9 c -55 33.4 -110.8 65.4 -167.1 96.5 c -43.4 24 -89 24.2 -132.3 0.5 c -57.5 -31.3 -114.2 -64 -170 -98.3 c -41 -25.1 -62.9 -63.7 -64.5 -112.2 C 183.5 621.9 184.3 588.9 184.4 555.9 Z M 232.9 556.3 c 0 29.5 0.5 59.1 -0.1 88.6 c -0.8 39.2 16.9 67.1 50.2 86.2 c 51.2 29.4 102.2 59.2 153.4 88.4 c 31.4 17.9 63.6 18.3 95 0.6 c 53.7 -30.3 107.1 -61.2 160.3 -92.5 c 29.7 -17.5 45 -44.5 45.3 -78.8 c 0.6 -61.7 0.5 -123.5 0 -185.2 c -0.3 -34.4 -15.3 -61.5 -44.9 -79 C 637.7 352.6 583 320.8 527.9 290 c -27.5 -15.4 -57.2 -16.1 -84.7 -0.7 c -56.9 31.6 -113.4 64 -169.1 97.6 c -26.4 15.9 -40.7 41.3 -41.1 72.9 C 232.6 491.9 232.9 524.1 232.9 556.3 Z" />
|
||||
<path class="logoRing innerRing" d="M 484.9 424.4 c 69.8 -2.8 133.2 57.8 132.6 132 C 617 630 558.5 688.7 484.9 689.1 c -75.1 0.4 -132.6 -63.6 -132.7 -132.7 C 352.1 485 413.4 421.5 484.9 424.4 Z M 401.3 556.7 c -3.4 37.2 30.5 83.6 83 84.1 c 46.6 0.4 84.8 -37.6 84.9 -84 c 0.1 -46.6 -37.2 -84.4 -84.2 -84.6 C 432.2 472.1 397.9 518.3 401.3 556.7 Z" />
|
||||
</g>
|
||||
</svg>
|
||||
<h2>Facebook Open Source</h2>
|
||||
</div>
|
||||
<div class="footerSection">
|
||||
<a class="footerLink" href="https://code.facebook.com/projects/" target="_blank">Open Source Projects</a>
|
||||
<a class="footerLink" href="https://github.com/facebook/" target="_blank">GitHub</a>
|
||||
<a class="footerLink" href="https://twitter.com/fbOpenSource" target="_blank">Twitter</a>
|
||||
</div>
|
||||
<div class="footerSection rightAlign">
|
||||
<a class="footerLink" href="https://github.com/caffe2/caffe2" target="_blank">Contribute to this project on GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript" src="/js/jekyll-link-anchors.js"></script>
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', '{{ site.gacode }}', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,57 +0,0 @@
|
||||
<!-- HTML header for doxygen 1.8.14-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link rel="icon" href="/static/favicon.png" type="image/x-icon">
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo" width="56"><a href="/"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">$projectname
|
||||
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
|
||||
</div>
|
||||
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
|
||||
</td>
|
||||
<!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_BRIEF-->
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<td>$searchbox</td>
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
@ -1,69 +0,0 @@
|
||||
## Building Caffe2
|
||||
|
||||
This guide builds from source. For alternatives, refer to https://caffe2.ai/docs/getting-started.html
|
||||
|
||||
Get latest source from GitHub.
|
||||
|
||||
git clone --recursive https://github.com/caffe2/caffe2.git
|
||||
cd caffe2
|
||||
|
||||
Note that you might need to uninstall existing Eigen and pybind11 packages due to compile-time dependencies when building from source. For this reason, Caffe2 uses git submodules to reference external packages in the third_party folder. These are downloaded with the --recursive option.
|
||||
|
||||
#### MacOS X
|
||||
|
||||
brew install openblas glog gtest automake protobuf leveled lmdb
|
||||
mkdir build && cd build
|
||||
cmake .. -DBLAS=OpenBLAS -DUSE_OPENCV=off
|
||||
make
|
||||
|
||||
#### Ubuntu
|
||||
|
||||
###### Ubuntu 14.04 LTS
|
||||
sudo apt-get install libprotobuf-dev protobuf-compiler libatlas-base-dev libgoogle-glog-dev libgtest-dev liblmdb-dev libleveldb-dev libsnappy-dev python-dev python-pip libiomp-dev libopencv-dev libpthread-stubs0-dev cmake
|
||||
sudo pip install numpy
|
||||
wget http://developer.download.nvidia.com/compute/cuda/repos/ubuntu1404/x86_64/cuda-repo-ubuntu1404_8.0.44-1_amd64.deb
|
||||
sudo dpkg -i cuda-repo-ubuntu1404_8.0.44-1_amd64.deb
|
||||
sudo apt-get update
|
||||
sudo apt-get install cuda
|
||||
sudo apt-get install git
|
||||
|
||||
CUDNN_URL="http://developer.download.nvidia.com/compute/redist/cudnn/v5.1/cudnn-8.0-linux-x64-v5.1.tgz" &&
|
||||
curl -fsSL ${CUDNN_URL} -O &&
|
||||
sudo tar -xzf cudnn-8.0-linux-x64-v5.1.tgz -C /usr/local &&
|
||||
rm cudnn-8.0-linux-x64-v5.1.tgz &&
|
||||
sudo ldconfig
|
||||
|
||||
mkdir build && cd build
|
||||
cmake ..
|
||||
make
|
||||
|
||||
###### Ubuntu 16.04 LTS
|
||||
sudo apt-get install libprotobuf-dev protobuf-compiler libatlas-base-dev libgoogle-glog-dev libgtest-dev liblmdb-dev libleveldb-dev libsnappy-dev python-dev python-pip libiomp-dev libopencv-dev libpthread-stubs0-dev cmake
|
||||
sudo pip install numpy
|
||||
wget http://developer.download.nvidia.com/compute/cuda/repos/ubuntu1604/x86_64/cuda-repo-ubuntu1604_8.0.61-1_amd64.deb
|
||||
sudo dpkg -i cuda-repo-ubuntu1604_8.0.61-1_amd64.deb
|
||||
sudo apt-get update
|
||||
sudo apt-get install cuda
|
||||
sudo apt-get install git
|
||||
|
||||
CUDNN_URL="http://developer.download.nvidia.com/compute/redist/cudnn/v5.1/cudnn-8.0-linux-x64-v5.1.tgz" &&
|
||||
curl -fsSL ${CUDNN_URL} -O &&
|
||||
sudo tar -xzf cudnn-8.0-linux-x64-v5.1.tgz -C /usr/local &&
|
||||
rm cudnn-8.0-linux-x64-v5.1.tgz &&
|
||||
sudo ldconfig
|
||||
|
||||
mkdir build && cd build
|
||||
cmake ..
|
||||
make
|
||||
|
||||
## Python support
|
||||
|
||||
To run the tutorials, download additional source from GitHub.
|
||||
|
||||
git clone --recursive https://github.com/caffe2/tutorials.git caffe2_tutorials
|
||||
cd caffe2_tutorials
|
||||
|
||||
You'll also need jupyter (formerly ipython) notebooks and matplotlib, which can be installed on MacOS X with
|
||||
|
||||
brew install matplotlib --with-python3
|
||||
pip install jupyter
|
||||
File diff suppressed because one or more lines are too long
@ -1,62 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
## @package process
|
||||
# Module doxygen.process
|
||||
# Script to insert preamble for doxygen and regen API docs
|
||||
|
||||
import os
|
||||
import shutil
|
||||
|
||||
|
||||
# Module caffe2...caffe2.python.control_test
|
||||
def insert(originalfile, first_line, description):
|
||||
with open(originalfile) as f:
|
||||
f1 = f.readline()
|
||||
if f1.find(first_line) < 0:
|
||||
docs = first_line + description + f1
|
||||
with open("newfile.txt", "w") as f2:
|
||||
f2.write(docs)
|
||||
f2.write(f.read())
|
||||
os.rename("newfile.txt", originalfile)
|
||||
else:
|
||||
print("already inserted")
|
||||
|
||||
|
||||
# move up from /caffe2_root/doxygen
|
||||
os.chdir("..")
|
||||
os.system("git checkout caffe2/contrib/.")
|
||||
os.system("git checkout caffe2/distributed/.")
|
||||
os.system("git checkout caffe2/experiments/.")
|
||||
os.system("git checkout caffe2/python/.")
|
||||
|
||||
for root, dirs, files in os.walk("."):
|
||||
for file in files:
|
||||
if (
|
||||
file.endswith(".py")
|
||||
and not file.endswith("_test.py")
|
||||
and not file.endswith("__.py")
|
||||
):
|
||||
filepath = os.path.join(root, file)
|
||||
print("filepath: " + filepath)
|
||||
directory = os.path.dirname(filepath)[2:]
|
||||
directory = directory.replace("/", ".")
|
||||
print("directory: " + directory)
|
||||
name = os.path.splitext(file)[0]
|
||||
first_line = "## @package " + name
|
||||
description = "\n# Module " + directory + "." + name + "\n"
|
||||
print(first_line, description)
|
||||
insert(filepath, first_line, description)
|
||||
|
||||
if os.path.exists("doxygen/doxygen-python"):
|
||||
print("Looks like you ran this before, so we need to cleanup those old files...")
|
||||
shutil.rmtree("doxygen/doxygen-python")
|
||||
else:
|
||||
os.makedirs("doxygen/doxygen-python")
|
||||
|
||||
if os.path.exists("doxygen/doxygen-c"):
|
||||
print("Looks like you ran this before, so we need to cleanup those old files...")
|
||||
shutil.rmtree("doxygen/doxygen-c")
|
||||
else:
|
||||
os.makedirs("doxygen/doxygen-c")
|
||||
|
||||
os.system("doxygen .Doxyfile-python")
|
||||
os.system("doxygen .Doxyfile-c")
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user