diff --git a/doc/_static/cn.svg b/doc/_static/cn.svg new file mode 100644 index 000000000..515176d60 --- /dev/null +++ b/doc/_static/cn.svg @@ -0,0 +1,20 @@ + + + + Flag of the People's Republic of China + + + + + + + + + + + + + + + + diff --git a/doc/_static/js/auto_module_index.js b/doc/_static/js/auto_module_index.js new file mode 100644 index 000000000..b918ecdc1 --- /dev/null +++ b/doc/_static/js/auto_module_index.js @@ -0,0 +1,25 @@ +function auto_index(module) { + $(document).ready(function () { + // find all classes or functions + var div_query = "div[class='section'][id='module-" + module + "']"; + var class_query = div_query + " dl[class='class'] > dt"; + var func_query = div_query + " dl[class='function'] > dt"; + var targets = $(class_query + ',' + func_query); + + var li_node = $("li a[href='#module-" + module + "']").parent(); + var html = ""; + li_node.append(html); + }); +} + diff --git a/doc/_static/us.svg b/doc/_static/us.svg new file mode 100644 index 000000000..1d621f96d --- /dev/null +++ b/doc/_static/us.svg @@ -0,0 +1,117 @@ + + + + + + image/svg+xml + + + + + The United States of America flag, produced by Daniel McRae + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/xgboost-theme/footer.html b/doc/_static/xgboost-theme/footer.html new file mode 100644 index 000000000..148bcb7df --- /dev/null +++ b/doc/_static/xgboost-theme/footer.html @@ -0,0 +1,5 @@ +
+
+

© 2015-2016 DMLC. All rights reserved.

+
+
diff --git a/doc/_static/xgboost-theme/index.html b/doc/_static/xgboost-theme/index.html new file mode 100644 index 000000000..852e00a1a --- /dev/null +++ b/doc/_static/xgboost-theme/index.html @@ -0,0 +1,58 @@ +
+
+
+
+

Scalable and Flexible Gradient Boosting

+
+ + + + +
+
+ Get Started +
+
+
+
+
+ +
+
+
+
+

Flexible

+

Supports regression, classification, ranking and user defined objectives. +

+
+
+

Portable

+

Runs on Windows, Lunix and OSX, as well as various cloud Platforms

+
+
+

Multiple Lanuages

+

Supports multiple languages including C++, Python, R, Java, Scala, Julia.

+
+
+

Battle-tested

+

Wins many data science and machine learning challenges. + Used in production by multiple companies. +

+
+
+

Distributed on Cloud

+

Supports distributed training on multiple machines, including AWS, + GCE, Azure, and Yarn clusters. Can be integrated with Flink, Spark and other cloud dataflow systems.

+
+
+

Performance

+

The well-optimized backend system for the best performance with limited resources. + The distributed version solves problems beyond billions of examples with same code. +

+
+
+
+
+ diff --git a/doc/_static/xgboost-theme/layout.html b/doc/_static/xgboost-theme/layout.html new file mode 100644 index 000000000..2931fe594 --- /dev/null +++ b/doc/_static/xgboost-theme/layout.html @@ -0,0 +1,156 @@ +{%- block doctype -%} + +{%- endblock %} +{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} +{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} +{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and + (sidebars != []) %} +{%- set url_root = pathto('', 1) %} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} +{%- if not embedded and docstitle %} + {%- set titlesuffix = " — "|safe + docstitle|e %} +{%- else %} + {%- set titlesuffix = "" %} +{%- endif %} + +{%- macro searchform(classes, button) %} + +{%- endmacro %} + +{%- macro sidebarglobal() %} + +{%- endmacro %} + +{%- macro sidebar() %} + {%- if render_sidebar %} + + {%- endif %} +{%- endmacro %} + + +{%- macro script() %} + + + {% for name in ['jquery.js', 'underscore.js', 'doctools.js', 'searchtools.js'] %} + + {% endfor %} + + + + + + +{%- endmacro %} + +{%- macro css() %} + + {% if pagename == 'index' %} + + {%- else %} + + + {%- endif %} + + +{%- endmacro %} + + + + + + + {# The above 3 meta tags *must* come first in the head; any other head content + must come *after* these tags. #} + {{ metatags }} + {%- block htmltitle %} + {%- if pagename != 'index' %} + {{ title|striptags|e }}{{ titlesuffix }} + {%- else %} + XGBoost Documents + {%- endif %} + {%- endblock %} + {{ css() }} + {%- if not embedded %} + {{ script() }} + {%- if use_opensearch %} + + {%- endif %} + {%- if favicon %} + + {%- endif %} + {%- endif %} +{%- block linktags %} + {%- if hasdoc('about') %} + + {%- endif %} + {%- if hasdoc('genindex') %} + + {%- endif %} + {%- if hasdoc('search') %} + + {%- endif %} + {%- if hasdoc('copyright') %} + + {%- endif %} + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} +{%- endblock %} +{%- block extrahead %} {% endblock %} + + + + + {%- include "navbar.html" %} + + {% if pagename != 'index' %} +
+
+ {{ sidebar() }} +
+ {% block body %} {% endblock %} + {%- include "footer.html" %} +
+
+
+ {%- else %} + {%- include "index.html" %} + {%- include "footer.html" %} + {%- endif %} + + + + diff --git a/doc/_static/xgboost-theme/navbar.html b/doc/_static/xgboost-theme/navbar.html new file mode 100644 index 000000000..44c66cf9c --- /dev/null +++ b/doc/_static/xgboost-theme/navbar.html @@ -0,0 +1,40 @@ +
+
+
+ +
+ +
+
diff --git a/doc/_static/xgboost-theme/theme.conf b/doc/_static/xgboost-theme/theme.conf new file mode 100644 index 000000000..89e03bbda --- /dev/null +++ b/doc/_static/xgboost-theme/theme.conf @@ -0,0 +1,2 @@ +[theme] +inherit = basic diff --git a/doc/_static/xgboost.css b/doc/_static/xgboost.css new file mode 100644 index 000000000..f4862a706 --- /dev/null +++ b/doc/_static/xgboost.css @@ -0,0 +1,232 @@ +/* header section */ +.splash{ + padding:5em 0 1em 0; + background-color:#0079b2; + /* background-image:url(../img/bg.jpg); */ + background-size:cover; + background-attachment:fixed; + color:#fff; + text-align:center +} + +.splash h1{ + font-size: 40px; + margin-bottom: 20px; +} +.splash .social{ + margin:2em 0 +} + +.splash .get_start { + margin:2em 0 +} + +.splash .get_start_btn { + border: 2px solid #FFFFFF; + border-radius: 5px; + color: #FFFFFF; + display: inline-block; + font-size: 26px; + padding: 9px 20px; +} + +.section-tout{ + padding:3em 0 3em; + border-bottom:1px solid rgba(0,0,0,.05); + background-color:#eaf1f1 +} +.section-tout .fa{ + margin-right:.5em +} + +.section-tout h3{ + font-size:20px; +} + +.section-tout p { + margin-bottom:2em +} + +.section-inst{ + padding:3em 0 3em; + border-bottom:1px solid rgba(0,0,0,.05); + + text-align:center +} + +.section-inst p { + margin-bottom:2em +} +.section-inst img { + -webkit-filter: grayscale(90%); /* Chrome, Safari, Opera */ + filter: grayscale(90%); + margin-bottom:2em +} +.section-inst img:hover { + -webkit-filter: grayscale(0%); /* Chrome, Safari, Opera */ + filter: grayscale(0%); +} + +.footer{ + padding-top: 40px; +} +.footer li{ + float:right; + margin-right:1.5em; + margin-bottom:1.5em +} +.footer p{ + font-size: 15px; + color: #888; + clear:right; + margin-bottom:0 +} + + +/* sidebar */ +div.sphinxsidebar { + margin-top: 20px; + margin-left: 0; + position: fixed; + overflow-y: scroll; + width: 250px; + top: 52px; + bottom: 0; + display: none +} +div.sphinxsidebar ul { padding: 0 } +div.sphinxsidebar ul ul { margin-left: 15px } + +@media (min-width:1200px) { + .content { float: right; width: 66.66666667%; margin-right: 5% } + div.sphinxsidebar {display: block} +} + + +.github-btn { border: 0; overflow: hidden } + +.container { + margin-right: auto; + margin-left: auto; + padding-left: 15px; + padding-right: 15px +} + +body>.container { + padding-top: 80px +} + +body { + font-size: 16px; +} + +pre { + font-size: 14px; +} + +/* navbar */ +.navbar { + background-color:#0079b2; + border: 0px; + height: 65px; +} +.navbar-right li { + display:inline-block; + vertical-align:top; + padding: 22px 4px; +} + +.navbar-left li { + display:inline-block; + vertical-align:top; + padding: 17px 10px; + /* margin: 0 5px; */ +} + +.navbar-left li a { + font-size: 22px; + color: #fff; +} + +.navbar-left > li > a:hover{ + color:#fff; +} +.flag-icon { + background-size: contain; + background-position: 50%; + background-repeat: no-repeat; + position: relative; + display: inline-block; + width: 1.33333333em; + line-height: 1em; +} + +.flag-icon:before { + content: "\00a0"; +} + + +.flag-icon-cn { + background-image: url(./cn.svg); +} + +.flag-icon-us { + background-image: url(./us.svg); +} + + +/* .flags { */ +/* padding: 10px; */ +/* } */ + +.navbar-brand >img { + width: 110px; +} + +.dropdown-menu li { + padding: 0px 0px; + width: 120px; +} +.dropdown-menu li a { + color: #0079b2; + font-size: 20px; +} + +.section h1 { + padding-top: 90px; + margin-top: -60px; + padding-bottom: 10px; + font-size: 28px; +} + +.section h2 { + padding-top: 80px; + margin-top: -60px; + padding-bottom: 10px; + font-size: 22px; +} + +.section h3 { + padding-top: 80px; + margin-top: -64px; + padding-bottom: 8px; +} + +.section h4 { + padding-top: 80px; + margin-top: -64px; + padding-bottom: 8px; +} + +dt { + margin-top: -76px; + padding-top: 76px; +} + +dt:target, .highlighted { + background-color: #fff; +} + +.section code.descname { + font-size: 1em; +}