Skip to content

GitLab

Unverified Commit 672d0e52 authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

[doc] added logo to docs (#3327)

parent 4d8d289d
Hide whitespace changes
Inline Side-by-side
Showing with 131 additions and 1 deletion
README.md
View file @ 672d0e52
<img src=https://github.com/microsoft/LightGBM/blob/master/logo/logo_black_font.png width=300 /> <img src=https://github.com/microsoft/LightGBM/blob/master/docs/logo/LightGBM_logo_black_text.svg width=300 />
Light Gradient Boosting Machine Light Gradient Boosting Machine
=============================== ===============================
......
docs/FAQ.rst
View file @ 672d0e52
...@@ -198,6 +198,11 @@ This is a known issue of CMake when using MinGW. The easiest solution is to run ...@@ -198,6 +198,11 @@ This is a known issue of CMake when using MinGW. The easiest solution is to run
See `Microsoft/LightGBM#3060 <https://github.com/microsoft/LightGBM/issues/3060#issuecomment-626338538>`__ for more details. See `Microsoft/LightGBM#3060 <https://github.com/microsoft/LightGBM/issues/3060#issuecomment-626338538>`__ for more details.
15. Where can I find LightGBM's logo to use it in my presentation?
------------------------------------------------------------------
You can find LightGBM's logo in different file formats and resolutions `here <https://github.com/microsoft/LightGBM/tree/master/docs/logo>`__.
------ ------
R-package R-package
......
docs/conf.py
View file @ 672d0e52
...@@ -100,6 +100,15 @@ project = 'LightGBM' ...@@ -100,6 +100,15 @@ project = 'LightGBM'
copyright = '%s, Microsoft Corporation' % str(datetime.datetime.now().year) copyright = '%s, Microsoft Corporation' % str(datetime.datetime.now().year)
author = 'Microsoft Corporation' author = 'Microsoft Corporation'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = os.path.join(CURR_PATH, 'logo', 'LightGBM_logo_grey_text.svg')
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = os.path.join(CURR_PATH, '_static', 'images', 'favicon.ico')
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
...@@ -152,6 +161,7 @@ html_theme = 'sphinx_rtd_theme' ...@@ -152,6 +161,7 @@ html_theme = 'sphinx_rtd_theme'
# documentation. # documentation.
html_theme_options = { html_theme_options = {
'includehidden': False, 'includehidden': False,
'logo_only': True,
} }
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
...@@ -164,6 +174,12 @@ html_static_path = ['_static'] ...@@ -164,6 +174,12 @@ html_static_path = ['_static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'LightGBMdoc' htmlhelp_basename = 'LightGBMdoc'
# -- Options for LaTeX output ---------------------------------------------
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = os.path.join(CURR_PATH, 'logo', 'LightGBM_logo_black_text_small.png')
def generate_doxygen_xml(app): def generate_doxygen_xml(app):
"""Generate XML documentation for C API by Doxygen. """Generate XML documentation for C API by Doxygen.
......
docs/index.rst
View file @ 672d0e52
...@@ -3,6 +3,12 @@ ...@@ -3,6 +3,12 @@
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.
.. image:: ./logo/LightGBM_logo_black_text.svg
:align: center
:width: 600
|
Welcome to LightGBM's documentation! Welcome to LightGBM's documentation!
==================================== ====================================
......
docs/logo/LightGBM_logo_black_text.svg 0 → 100644
View file @ 672d0e52
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Creator: CorelDRAW 2020 (64-Bit Evaluation Version) -->
<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="4672px" height="1058px" version="1.1" style="shape-rendering:geometricPrecision; text-rendering:geometricPrecision; image-rendering:optimizeQuality; fill-rule:evenodd; clip-rule:evenodd"
viewBox="0 0 4645.44 1052.32"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xodm="http://www.corel.com/coreldraw/odm/2003">
<defs>
<style type="text/css">
<![CDATA[
.fil0 {fill:none}
.fil5 {fill:#1B9AD7}
.fil2 {fill:#76B644}
.fil1 {fill:#EF4927}
.fil4 {fill:#FCB518}
.fil3 {fill:#4B4B4D;fill-rule:nonzero}
]]>
</style>
</defs>
<g id="图层_x0020_1">
<metadata id="CorelCorpID_0Corel-Layer"/>
<rect class="fil0" width="4645.44" height="1052.32"/>
<polygon class="fil1" points="629.73,0.27 0,0.27 0,403.33 "/>
<polygon class="fil2" points="262.04,431.06 629.75,192.72 629.75,503.23 "/>
<g>
<path class="fil3" d="M4645.44 837.58l-103.46 0 4.34 -529.43c-6.44,27.4 -12.13,47.17 -17.07,59.14l-187.75 470.29 -71.87 0 -188.21 -466.69c-5.24,-13.78 -10.93,-34.74 -16.77,-62.74l-1.65 0c2.25,25.16 3.45,66.18 3.45,123.23l0 406.2 -96.42 0 0 -628.99 146.88 0 165.29 418.93c12.58,32.19 20.82,56.15 24.71,71.87l2.1 0c10.93,-33.09 19.61,-57.65 26.34,-73.67l168.45 -417.13 141.64 0 0 628.99zm-375.81 0l-253.66 -628.99 100.94 0 192.1 490.8 -39.38 138.19zm322.98 -628.99l-88.81 0 88.81 0zm0 0l-251.11 628.99 -33.01 -139.52 195.31 -489.47 88.81 0z"/>
</g>
<path class="fil3" d="M3449.37 834.75l0 -625.48 198.47 0c60.45,0 108.4,13.25 143.68,39.6 35.29,26.51 53.01,61.05 53.01,103.48 0,35.44 -10.13,66.26 -30.08,92.46 -20.1,26.21 -47.94,44.82 -83.38,55.84l0 1.78c43.03,4.92 77.42,20.85 103.18,47.65 25.76,26.95 38.57,61.94 38.57,104.96 0,53.46 -21,96.78 -63.13,129.99 -42.29,33.2 -95.44,49.72 -159.76,49.72l-200.56 0zm103.39 -534.58l0.2 136.51c0.04,24.18 -2.1,34.43 28.69,34.19l38.2 -0.3c36.03,-0.28 64.32,-8.49 84.87,-25.61 20.55,-16.97 30.67,-41.09 30.67,-72.21 0,-53.45 -35.73,-80.25 -107.2,-80.25l-66.2 0c-6.79,0 -9.25,0.65 -9.23,7.67zm-0.06 264.61l0 154.26c0,26.53 -0.42,32.78 28.85,32.78l59.74 0c38.56,0 68.49,-8.93 89.63,-26.8 21,-17.86 31.57,-42.43 31.57,-73.85 0,-64.91 -44.97,-97.37 -134.75,-97.37l-63.23 0c-8.81,0 -11.81,2.15 -11.81,10.98z"/>
<path class="fil3" d="M3351.47 783.93c-63.06,34.27 -133.19,51.4 -210.51,51.4 -89.42,0 -161.85,-27.79 -217.29,-83.51 -55.43,-55.58 -83.08,-129.31 -83.08,-221.03 0,-93.59 30.24,-170.48 90.86,-230.53 60.62,-60.04 137.66,-90.14 230.96,-90.14 63.51,0 117.52,8.86 161.89,26.47 8.49,3.37 7.73,1.48 7.73,10.2l0 96.24c-46.36,-30.82 -101.65,-46.37 -165.73,-46.37 -64.51,0 -117.21,21.31 -158.39,63.65 -41.18,42.47 -61.92,97.48 -61.92,165.01 0,69.4 17.86,124.12 53.28,163.86 35.42,39.89 83.52,59.76 144.28,59.76 36.83,0 69.27,-6.32 97.3,-18.85 13.55,-6.06 10.69,-4.56 10.69,-19.42l0 -118.76c0,-9.58 -4.78,-10.86 -13.69,-10.86l-113.74 0 0 -66.84c0,-14.7 3.11,-17.54 18.89,-17.54l208.47 0 0 287.26z"/>
<path class="fil3" d="M2773.73 821.77c-19.51,9.22 -45.03,13.83 -76.43,13.83 -87.14,0 -130.71,-41.77 -130.71,-125.47l0 -253.93 -37.51 0 0 -79.81 37.51 0 -0.08 -113.52c0,-7.1 2.14,-11.35 9.03,-14.4l92.74 -41.07 0.12 168.99 107.36 0 0 79.81 -107.36 0 0 224.59c0,26.65 4.79,45.66 14.37,57.04 9.74,11.38 25.76,17.07 48.37,17.07 17.22,0 32.04,-4.94 44.62,-14.82l0 78.4c0,2.65 0.39,2.15 -2.03,3.29z"/>
<path class="fil3" d="M2464.86 837.58l-101.66 0 0 -245.7c0,-88.78 -29.8,-133.25 -89.09,-133.25 -29.79,0 -54.95,12.87 -75.46,38.63 -20.51,25.6 -30.69,58.54 -30.69,98.67l0 241.65 -102.27 0 0 -624.07c0,-5.64 3.31,-4.95 8.1,-4.95l90.21 0c2.37,0 3.96,-0.37 3.96,2.55l0 251.86 1.79 0c33.84,-56.75 82.5,-85.05 145.54,-85.05 99.71,0 149.57,60.94 149.57,182.82l0 276.84z"/>
<path class="fil3" d="M2002.55 789.04c0,164.85 -82.95,247.35 -248.69,247.35 -58.55,0 -109.6,-9.73 -153.17,-29.35l83.52 -58.21c18.34,7.63 38.08,7.31 56.47,7.31 106.76,0 160.06,-52.56 160.06,-157.52l0 -49.11 -1.8 0c-33.54,57.35 -84.14,85.95 -151.67,85.95 -54.65,0 -98.82,-19.92 -132.36,-59.89 -33.39,-39.83 -50.16,-93.43 -50.16,-160.66 0,-76.36 17.97,-137 53.9,-182.07 36.09,-45.06 85.5,-67.52 148.38,-67.52 59.29,0 103.31,24.25 131.91,72.76l1.8 0 0 -49.59c0,-10.62 1.64,-12.69 12.25,-12.69l76.07 0c12.33,0 13.49,-0.94 13.49,11.4l0 401.84zm-100.91 -169.79l0 -58.39c0,-31.59 -10.48,-58.54 -31.3,-80.85 -20.96,-22.46 -47.01,-33.54 -78.3,-33.54 -38.63,0 -68.88,14.22 -90.59,42.67 -21.86,28.6 -32.79,68.43 -32.79,119.63 0,44.17 10.48,79.36 31.45,105.86 20.81,26.5 48.66,39.67 83.09,39.67 35.04,0 63.64,-12.57 85.5,-37.88 22.01,-25.3 32.94,-57.64 32.94,-97.17z"/>
<path class="fil3" d="M1499.16 837.58l-101.81 0 0 -441.66c0,-5.84 1.24,-7.51 7.73,-7.51l84.14 0c8.97,0 9.94,-0.28 9.94,8.05l0 441.12z"/>
<path class="fil3" d="M1447.36 304.51c-13.77,0 -25.56,-4.47 -35.36,-13.4 -9.93,-9.06 -14.77,-20.35 -14.77,-34.25 0,-13.77 4.84,-25.31 14.77,-34.49 9.8,-9.18 21.59,-13.77 35.36,-13.77 14.27,0 26.43,4.59 36.35,13.77 9.93,9.18 14.89,20.72 14.89,34.49 0,13.16 -4.96,24.32 -14.89,33.63 -9.92,9.31 -22.08,14.02 -36.35,14.02z"/>
<path class="fil3" d="M984.92 837.58l0 -622.86c0,-6.28 2.75,-6.13 8.19,-6.13l88.48 0c5.21,0 7.69,-0.29 7.69,5.73l0 531.65c0,4.06 1.5,3.42 4.8,3.42l230.79 0c4.41,0 8.31,-0.51 8.31,5.47l0 82.64 -348.26 0.08z"/>
<polygon class="fil4" points="0.02,1047.61 629.75,1047.61 629.75,644.55 "/>
<polygon class="fil5" points="367.7,618.99 0,857.33 0,546.82 "/>
</g>
</svg>
docs/logo/LightGBM_logo_grey_text.svg 0 → 100644
View file @ 672d0e52
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Creator: CorelDRAW 2020 (64-Bit Evaluation Version) -->
<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="4672px" height="1053px" version="1.1" style="shape-rendering:geometricPrecision; text-rendering:geometricPrecision; image-rendering:optimizeQuality; fill-rule:evenodd; clip-rule:evenodd"
viewBox="0 0 4645.44 1047.35"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xodm="http://www.corel.com/coreldraw/odm/2003">
<defs>
<style type="text/css">
<![CDATA[
.fil4 {fill:#1B9AD7}
.fil1 {fill:#76B644}
.fil0 {fill:#EF4927}
.fil3 {fill:#FCB518}
.fil2 {fill:#E6E7E8;fill-rule:nonzero}
]]>
</style>
</defs>
<g id="图层_x0020_1">
<metadata id="CorelCorpID_0Corel-Layer"/>
<polygon class="fil0" points="629.73,0 0,0 0,403.06 "/>
<polygon class="fil1" points="262.04,430.8 629.75,192.45 629.75,502.96 "/>
<g>
<path class="fil2" d="M4645.44 837.31l-103.46 0 4.34 -529.43c-6.44,27.4 -12.13,47.17 -17.07,59.15l-187.75 470.28 -71.87 0 -188.21 -466.69c-5.24,-13.78 -10.93,-34.74 -16.77,-62.74l-1.65 0c2.25,25.16 3.45,66.18 3.45,123.23l0 406.2 -96.42 0 0 -628.99 146.88 0 165.29 418.93c12.58,32.19 20.82,56.15 24.71,71.87l2.09 0c10.94,-33.09 19.62,-57.65 26.36,-73.67l168.44 -417.13 141.64 0 0 628.99zm-375.81 0l-253.66 -628.99 100.94 0 192.1 490.8 -39.38 138.19zm322.98 -628.99l-88.81 0 88.81 0zm0 0l-251.11 628.99 -33.01 -139.52 195.31 -489.47 88.81 0z"/>
</g>
<path class="fil2" d="M3449.37 834.49l0 -625.49 198.47 0c60.45,0 108.4,13.25 143.68,39.6 35.29,26.51 53.01,61.05 53.01,103.48 0,35.44 -10.13,66.26 -30.08,92.46 -20.1,26.21 -47.94,44.82 -83.38,55.84l0 1.78c43.03,4.92 77.42,20.85 103.18,47.65 25.76,26.95 38.57,61.94 38.57,104.97 0,53.45 -21,96.77 -63.13,129.98 -42.29,33.2 -95.44,49.73 -159.76,49.73l-200.56 0zm103.39 -534.59l0.2 136.51c0.04,24.18 -2.1,34.44 28.69,34.19l38.2 -0.3c36.03,-0.28 64.32,-8.48 84.87,-25.61 20.55,-16.97 30.67,-41.09 30.67,-72.21 0,-53.45 -35.73,-80.25 -107.2,-80.25l-66.2 0c-6.79,0 -9.25,0.65 -9.23,7.67zm-0.06 264.61l0 154.26c0,26.53 -0.42,32.78 28.85,32.78l59.74 0c38.56,0 68.49,-8.93 89.63,-26.8 21,-17.86 31.57,-42.43 31.57,-73.84 0,-64.92 -44.97,-97.38 -134.75,-97.38l-63.23 0c-8.81,0 -11.81,2.15 -11.81,10.98z"/>
<path class="fil2" d="M3351.47 783.66c-63.06,34.27 -133.19,51.41 -210.51,51.41 -89.42,0 -161.85,-27.8 -217.29,-83.52 -55.43,-55.58 -83.08,-129.3 -83.08,-221.03 0,-93.59 30.24,-170.48 90.86,-230.53 60.62,-60.04 137.66,-90.14 230.96,-90.14 63.51,0 117.52,8.87 161.89,26.47 8.49,3.37 7.73,1.48 7.73,10.2l0 96.24c-46.36,-30.82 -101.65,-46.37 -165.73,-46.37 -64.51,0 -117.21,21.31 -158.39,63.65 -41.18,42.47 -61.92,97.48 -61.92,165.01 0,69.4 17.86,124.12 53.28,163.86 35.42,39.89 83.52,59.76 144.28,59.76 36.83,0 69.27,-6.32 97.3,-18.85 13.55,-6.06 10.69,-4.56 10.69,-19.42l0 -118.76c0,-9.57 -4.78,-10.86 -13.69,-10.86l-113.74 0 0 -66.84c0,-14.7 3.11,-17.54 18.89,-17.54l208.47 0 0 287.26z"/>
<path class="fil2" d="M2773.73 821.5c-19.51,9.22 -45.03,13.84 -76.43,13.84 -87.14,0 -130.71,-41.78 -130.71,-125.47l0 -253.94 -37.51 0 0 -79.8 37.51 0 -0.08 -113.53c0,-7.1 2.14,-11.35 9.03,-14.4l92.74 -41.07 0.12 169 107.36 0 0 79.8 -107.36 0 0 224.59c0,26.65 4.79,45.66 14.37,57.04 9.74,11.38 25.76,17.07 48.37,17.07 17.22,0 32.04,-4.94 44.62,-14.82l0 78.4c0,2.65 0.39,2.15 -2.03,3.29z"/>
<path class="fil2" d="M2464.86 837.31l-101.66 0 0 -245.7c0,-88.78 -29.8,-133.25 -89.09,-133.25 -29.79,0 -54.95,12.87 -75.46,38.63 -20.51,25.6 -30.69,58.54 -30.69,98.67l0 241.65 -102.27 0 0 -624.07c0,-5.64 3.31,-4.95 8.1,-4.95l90.21 0c2.37,0 3.96,-0.37 3.96,2.55l0 251.86 1.79 0c33.84,-56.74 82.5,-85.04 145.54,-85.04 99.71,0 149.57,60.94 149.57,182.81l0 276.84z"/>
<path class="fil2" d="M2002.55 788.77c0,164.85 -82.95,247.35 -248.69,247.35 -58.55,0 -109.6,-9.73 -153.17,-29.35l83.52 -58.21c18.34,7.63 38.08,7.31 56.47,7.31 106.76,0 160.06,-52.56 160.06,-157.51l0 -49.12 -1.8 0c-33.54,57.35 -84.14,85.95 -151.67,85.95 -54.65,0 -98.82,-19.92 -132.36,-59.89 -33.39,-39.83 -50.16,-93.43 -50.16,-160.66 0,-76.36 17.97,-137 53.9,-182.06 36.09,-45.07 85.5,-67.53 148.38,-67.53 59.29,0 103.31,24.25 131.91,72.77l1.8 0 0 -49.6c0,-10.62 1.64,-12.69 12.25,-12.69l76.07 0c12.33,0 13.49,-0.94 13.49,11.4l0 401.84zm-100.91 -169.79l0 -58.39c0,-31.59 -10.48,-58.54 -31.3,-80.85 -20.96,-22.46 -47.01,-33.54 -78.3,-33.54 -38.63,0 -68.88,14.22 -90.59,42.67 -21.86,28.6 -32.79,68.43 -32.79,119.63 0,44.17 10.48,79.36 31.45,105.86 20.81,26.5 48.66,39.68 83.09,39.68 35.04,0 63.64,-12.58 85.5,-37.89 22.01,-25.3 32.94,-57.64 32.94,-97.17z"/>
<path class="fil2" d="M1499.16 837.31l-101.81 0 0 -441.66c0,-5.84 1.24,-7.51 7.73,-7.51l84.14 0c8.97,0 9.94,-0.28 9.94,8.05l0 441.12z"/>
<path class="fil2" d="M1447.36 304.24c-13.77,0 -25.56,-4.47 -35.36,-13.4 -9.93,-9.06 -14.77,-20.35 -14.77,-34.25 0,-13.77 4.84,-25.31 14.77,-34.49 9.8,-9.18 21.59,-13.77 35.36,-13.77 14.27,0 26.43,4.59 36.35,13.77 9.93,9.18 14.89,20.72 14.89,34.49 0,13.16 -4.96,24.32 -14.89,33.63 -9.92,9.31 -22.08,14.02 -36.35,14.02z"/>
<path class="fil2" d="M984.92 837.31l0 -622.86c0,-6.28 2.75,-6.13 8.19,-6.13l88.48 0c5.21,0 7.69,-0.29 7.69,5.73l0 531.65c0,4.06 1.5,3.43 4.8,3.43l230.79 0c4.41,0 8.31,-0.52 8.31,5.46l0 82.64 -348.26 0.08z"/>
<polygon class="fil3" points="0.02,1047.35 629.75,1047.35 629.75,644.28 "/>
<polygon class="fil4" points="367.7,618.72 0,857.06 0,546.56 "/>
</g>
</svg>
docs/logo/LightGBM_logo_no_text.svg 0 → 100644
View file @ 672d0e52
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Creator: CorelDRAW 2020 (64-Bit Evaluation Version) -->
<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="1800px" height="2907px" version="1.1" style="shape-rendering:geometricPrecision; text-rendering:geometricPrecision; image-rendering:optimizeQuality; fill-rule:evenodd; clip-rule:evenodd"
viewBox="0 0 1808.08 2919.85"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xodm="http://www.corel.com/coreldraw/odm/2003">
<defs>
<style type="text/css">
<![CDATA[
.fil4 {fill:none}
.fil3 {fill:#1B9AD7}
.fil1 {fill:#76B644}
.fil0 {fill:#EF4927}
.fil2 {fill:#FCB518}
]]>
</style>
</defs>
<g id="图层_x0020_1">
<metadata id="CorelCorpID_0Corel-Layer"/>
<polygon class="fil0" points="1732.73,84.18 71.14,84.18 71.14,1147.68 "/>
<polygon class="fil1" points="762.56,1220.86 1732.77,591.98 1732.77,1411.27 "/>
<polygon class="fil2" points="71.19,2847.67 1732.78,2847.67 1732.78,1784.16 "/>
<polygon class="fil3" points="1041.36,1716.72 71.15,2345.59 71.15,1526.3 "/>
<rect class="fil4" width="1808.08" height="2919.85"/>
</g>
</svg>
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