Unverified Commit 17fda872 authored by James Lamb's avatar James Lamb Committed by GitHub
Browse files

[docs] document use of EffVer (#6905)



* [docs] document use of EffVer

* change heading

* move nightly builds note

---------
Co-authored-by: default avatarNikita Titov <nekit94-08@mail.ru>
parent 6d7c7534
...@@ -12,6 +12,7 @@ Light Gradient Boosting Machine ...@@ -12,6 +12,7 @@ Light Gradient Boosting Machine
[![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/) [![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/)
[![Link checks](https://github.com/microsoft/LightGBM/actions/workflows/linkchecker.yml/badge.svg?branch=master)](https://github.com/microsoft/LightGBM/actions/workflows/linkchecker.yml) [![Link checks](https://github.com/microsoft/LightGBM/actions/workflows/linkchecker.yml/badge.svg?branch=master)](https://github.com/microsoft/LightGBM/actions/workflows/linkchecker.yml)
[![License](https://img.shields.io/github/license/microsoft/lightgbm.svg)](https://github.com/microsoft/LightGBM/blob/master/LICENSE) [![License](https://img.shields.io/github/license/microsoft/lightgbm.svg)](https://github.com/microsoft/LightGBM/blob/master/LICENSE)
[![EffVer Versioning](https://img.shields.io/badge/version_scheme-EffVer-0097a7)](https://jacobtomlinson.dev/effver)
[![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg?logo=python&logoColor=white)](https://pypi.org/project/lightgbm) [![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg?logo=python&logoColor=white)](https://pypi.org/project/lightgbm)
[![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg?logo=pypi&logoColor=white)](https://pypi.org/project/lightgbm) [![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg?logo=pypi&logoColor=white)](https://pypi.org/project/lightgbm)
[![conda Version](https://img.shields.io/conda/vn/conda-forge/lightgbm?logo=conda-forge&logoColor=white&label=conda)](https://anaconda.org/conda-forge/lightgbm) [![conda Version](https://img.shields.io/conda/vn/conda-forge/lightgbm?logo=conda-forge&logoColor=white&label=conda)](https://anaconda.org/conda-forge/lightgbm)
......
Installation Guide Installation Guide
================== ==================
Versioning
~~~~~~~~~~
LightGBM releases use a 3-part version number, with this format:
.. code::
{major}.{minor}.{patch}
This version follows a scheme called Intended Effort Versioning ("Effver" for short).
Changes to a component of the version indicate how much effort it will likely take to update
code using a previous version.
* ``major`` = updating will require significant effort
* ``minor`` = some effort
* ``patch`` = no or very little effort
This means that **new minor versions can contain breaking changes**, but these are typically
small or limited to less-frequently-used parts of the project.
When built from source on an unreleased commit, this version takes the following form:
.. code::
{major}.{minor}.{patch}.99
That ``.99`` is added to ensure that a version built from an unreleased commit is considered "newer"
than all previous releases, and "older" than all future releases.
.. _nightly-builds:
You can find such artifacts from the latest successful build on the ``master`` branch (nightly builds) here: |download artifacts|.
For more details on why LightGBM uses EffVer instead of other schemes like semantic versioning,
see https://jacobtomlinson.dev/effver/.
General Installation Notes
~~~~~~~~~~~~~~~~~~~~~~~~~~
All instructions below are aimed at compiling the 64-bit version of LightGBM. All instructions below are aimed at compiling the 64-bit version of LightGBM.
It is worth compiling the 32-bit version only in very rare special cases involving environmental limitations. It is worth compiling the 32-bit version only in very rare special cases involving environmental limitations.
The 32-bit version is slow and untested, so use it at your own risk and don't forget to adjust some of the commands below when installing. The 32-bit version is slow and untested, so use it at your own risk and don't forget to adjust some of the commands below when installing.
...@@ -41,10 +80,6 @@ Please note, that ThreadSanitizer cannot be used together with other sanitizers. ...@@ -41,10 +80,6 @@ Please note, that ThreadSanitizer cannot be used together with other sanitizers.
For more info and additional sanitizers' parameters please refer to the `following docs`_. For more info and additional sanitizers' parameters please refer to the `following docs`_.
It is very useful to build `C++ unit tests <#build-c-unit-tests>`__ with sanitizers. It is very useful to build `C++ unit tests <#build-c-unit-tests>`__ with sanitizers.
.. _nightly-builds:
You can download the artifacts of the latest successful build on master branch (nightly builds) here: |download artifacts|.
.. contents:: **Contents** .. contents:: **Contents**
:depth: 1 :depth: 1
:local: :local:
......
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