Skip to content

Commit 2d0937a

Browse files
committed
Removed pre-release info in intro.rst and simplified versioning paragraph in contributing.md
1 parent a8901da commit 2d0937a

File tree

3 files changed

+7
-11
lines changed

3 files changed

+7
-11
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ GPflowOpt currently tries to keep up with the GPflow master, though at some poin
2828
Changing the minimum required version of TensorFlow that we're compatible with requires a few tasks:
2929
- update versions in `setup.py`
3030
- update versions used on travis via `.travis.yml`
31-
- update version ussed by readthedocs.org via `docsrequire.txt`
31+
- update version used by readthedocs.org via `docsrequire.txt`
3232
- Increment the GPflowOpt version (see below).
3333

3434
## Version numbering
35-
The main purpose of versioning GPflowOpt is user convenience: to keep the number of releases down, we try to combine seversal PRs into one increment. As we work towards something that we might call 1.0, including changes to the GPflowOpt API. Minor version bumps (X.1) are used for updates to follow a new GPflow or TensorFlow API, or introduce incremental new features.
35+
The main purpose of versioning GPflowOpt is user convenience: to keep the number of releases down, we try to combine several PRs into one increment.
3636
When incrementing the version number, the following tasks are required:
3737
- Update the version in `GPflowOpt/_version.py`
3838
- Add a note to `RELEASE.md`

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# GPflowOpt
2-
GPflowOpt is a python package for Bayesian Optimization using [GPflow](https://github.com/GPflow/GPflow), and uses [TensorFlow](http://www.tensorflow.org). It was [initiated](https://github.com/GPflow/GPflow/issues/397) and is currently maintained by [Joachim van der Herten](http://sumo.intec.ugent.be/members?q=jvanderherten) and [Ivo Couckuyt](http://sumo.intec.ugent.be/icouckuy). The full list of contributors (in alphabetical order) is Ivo Couckuyt, Tom Dhaene, James Hensman, Nicolas Knudde, Alexander G. de G. Matthews and Joachim van der Herten. Special thanks also to all [GPflow contributors](http://github.com/GPflow/GPflow/graphs/contributors) as this package would not be able to exist without their effort.
2+
GPflowOpt is a python package for Bayesian Optimization using [GPflow](https://github.com/GPflow/GPflow), and uses [TensorFlow](http://www.tensorflow.org). It was [initiated](https://github.com/GPflow/GPflow/issues/397) and is currently maintained by [Joachim van der Herten](http://sumo.intec.ugent.be/members?q=jvanderherten) and [Ivo Couckuyt](http://sumo.intec.ugent.be/icouckuy). The full list of contributors (in alphabetical order) is Ivo Couckuyt, Tom Dhaene, James Hensman, Nicolas Knudde, Alexander G. de G. Matthews and Joachim van der Herten. Special thanks also to all [GPflow contributors](http://github.com/GPflow/GPflow/graphs/contributors) as this package would not be able to exist without their effort.
33

44
[![Build Status](https://travis-ci.org/GPflow/GPflowOpt.svg?branch=master)](https://travis-ci.org/GPflow/GPflowOpt)
55
[![Coverage Status](https://codecov.io/gh/GPflow/GPflowOpt/branch/master/graph/badge.svg)](https://codecov.io/gh/GPflow/GPflowOpt)
@@ -15,5 +15,3 @@ in the source directory. This also installs all required dependencies (including
1515

1616
# Contributing
1717
If you are interested in contributing to this open source project, contact us through an issue on this repository. For more information, see the [notes for contributors](contributing.md).
18-
19-

doc/source/intro.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ Introduction
66
It makes use of TensorFlow for computation of acquisition functions, to offer scalability, and avoid implementation of gradients.
77
The package was created, and is currently maintained by `Joachim van der Herten <http://sumo.intec.ugent.be/jvanderherten>`_ and `Ivo Couckuyt <http://sumo.intec.ugent.be/icouckuy>`_
88

9-
Currently the software is pre-release and under construction, hence it lacks a lot of functionality and testing. This documentation
10-
is also incomplete and under development. The project is open source: if you feel you have some relevant skills and are interested in
9+
The project is open source: if you feel you have some relevant skills and are interested in
1110
contributing then please contact us on `GitHub <https://github.com/GPflow/GPflowOpt>`_ by opening an issue or pull request.
1211

1312
Install
14-
--------
13+
-------
1514
1. Install package
1615

1716
A straightforward way to install GPflowOpt is to clone its repository and run
@@ -32,9 +31,8 @@ GPflowOpt is a pure python library so you could just add it to your python path.
3231
The tests require some additional dependencies that need to be installed first with
3332
``pip install -e .[test]``. Afterwards the tests can be run with ``python setup.py test``.
3433

35-
Similarly, to build the documentation,
36-
first install the extra dependencies with ``pip install -e .[docs]``.
37-
Then proceed with ``python setup.py build_sphinx``.
34+
Similarly, to build the documentation, first install the extra dependencies with
35+
``pip install -e .[docs]``. Then proceed with ``python setup.py build_sphinx``.
3836

3937
Getting started
4038
---------------

0 commit comments

Comments
 (0)