Commit 1cdb9718 authored by Paul's avatar Paul
Browse files

Update docs

parent d24755de
# MIGraph # AMD MIGraphX
AMD's library for graph optimizations. AMD's graph optimization engine.
## Prerequisites ## Prerequisites
* [ROCm cmake modules](https://github.com/RadeonOpenCompute/rocm-cmake) **required** * [ROCm cmake modules](https://github.com/RadeonOpenCompute/rocm-cmake) **required**
...@@ -20,7 +20,7 @@ cmake -P install_deps.cmake --prefix /some/local/dir ...@@ -20,7 +20,7 @@ cmake -P install_deps.cmake --prefix /some/local/dir
``` ```
## Building MIGraph from source ## Building MIGraphX from source
## Configuring with cmake ## Configuring with cmake
......
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# MIGraph documentation build configuration file, created by # MIGraphX documentation build configuration file, created by
# sphinx-quickstart on Thu Jul 19 11:38:13 2018. # sphinx-quickstart on Thu Jul 19 11:38:13 2018.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
...@@ -45,7 +45,7 @@ source_suffix = '.rst' ...@@ -45,7 +45,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'MIGraph' project = u'MIGraphX'
copyright = u'2018, AMD' copyright = u'2018, AMD'
author = u'AMD' author = u'AMD'
...@@ -101,7 +101,7 @@ html_static_path = ['_static'] ...@@ -101,7 +101,7 @@ html_static_path = ['_static']
# -- Options for HTMLHelp output ------------------------------------------ # -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'MIGraphdoc' htmlhelp_basename = 'MIGraphXdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
...@@ -128,7 +128,7 @@ latex_elements = { ...@@ -128,7 +128,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'MIGraph.tex', u'MIGraph Documentation', (master_doc, 'MIGraphX.tex', u'MIGraphX Documentation',
u'AMD', 'manual'), u'AMD', 'manual'),
] ]
...@@ -138,7 +138,7 @@ latex_documents = [ ...@@ -138,7 +138,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'migraphx', u'MIGraph Documentation', (master_doc, 'migraphx', u'MIGraphX Documentation',
[author], 1) [author], 1)
] ]
...@@ -149,8 +149,8 @@ man_pages = [ ...@@ -149,8 +149,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'MIGraph', u'MIGraph Documentation', (master_doc, 'MIGraphX', u'MIGraphX Documentation',
author, 'MIGraph', 'One line description of project.', author, 'MIGraphX', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
......
.. MIGraph documentation master file, created by .. MIGraphX documentation master file, created by
sphinx-quickstart on Thu Jul 19 11:38:13 2018. sphinx-quickstart on Thu Jul 19 11:38:13 2018.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to MIGraph's documentation! Welcome to AMD MIGraphX's documentation!
=================================== ========================================
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
......
Overview Overview
======== ========
MIGraph provides an optimized execution engine for deep learning neural networks. MIGraphX provides an optimized execution engine for deep learning neural networks.
Building a program Building a program
------------------ ------------------
......
Markdown is supported
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