Skip to content

Commit

Permalink
release 1.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenhky committed Jan 30, 2019
1 parent 65a02bf commit 86d8ad2
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 13 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ any classification algorithm. In this package, it facilitates various types
of these representations, including topic modeling and word-embedding algorithms.

Since release 1.0.0, `shorttext` runs on Python 2.7, 3.5, and 3.6.
Since release 1.0.7, it runs on Python 3.7 as well, but the backend for `keras` cannot be `TensorFlow`.

Characteristics:

Expand All @@ -32,7 +33,7 @@ Characteristics:

Documentation and tutorials for `shorttext` can be found here: [http://shorttext.rtfd.io/](http://shorttext.rtfd.io/).

[FAQ](https://shorttext.readthedocs.io/en/latest/faq.html).
See [tutorial](http://shorttext.readthedocs.io/en/latest/tutorial.html) for how to use the package, and [FAQ](https://shorttext.readthedocs.io/en/latest/faq.html).

## Installation

Expand All @@ -42,7 +43,7 @@ To install it, in a console, use `pip`.
>>> pip install -U shorttext
```

or, if you want the most updated code that is not released on PyPI yet, type
or, if you want the most recent development version on Github, type

```
>>> pip install -U git+https://github.com/stephenhky/PyShortTextCategorization@master
Expand All @@ -56,7 +57,8 @@ Before using, check the language model of spaCy has been installed or updated, b
>>> python -m spacy download en
```

See [tutorial](http://shorttext.readthedocs.io/en/latest/tutorial.html) for how to use the package.
See [installation guide](https://shorttext.readthedocs.io/en/latest/install.html) for more details.


## Issues

Expand All @@ -82,6 +84,7 @@ If you would like to contribute, feel free to submit the pull requests. You can

## News

* 01/30/2019: `shorttext` 1.0.7 released.
* 01/29/2019: `shorttext` 1.0.6 released.
* 01/13/2019: `shorttext` 1.0.5 released.
* 10/03/2018: `shorttext` 1.0.4 released.
Expand Down Expand Up @@ -124,5 +127,4 @@ If you would like to contribute, feel free to submit the pull requests. You can
- [ ] More scalability;
- [ ] Including BERT models;
- [ ] Dividing components to other packages;
- [ ] Compatibility with Python 3.7;
- [ ] More available corpus.
2 changes: 1 addition & 1 deletion apidocs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0.6'
release = '1.0.7'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
# The short X.Y version.
version = u'1.0'
# The full version, including alpha/beta/rc tags.
release = u'1.0.6'
release = u'1.0.7'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 4 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,8 @@ Ans: This functionality is removed since release 0.5.11, due to the following re

Ans: There is no "Python.h". Run: `sudo apt-get install python3-dev` in SSH shell of the VM instance.





Home: :doc:`index`
47 changes: 42 additions & 5 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Installation
PIP
---

Package `shorttext` runs in Python 2.7, 3.5, and 3.6.
Package `shorttext` runs in Python 2.7, 3.5, 3.6, and 3.7. However, for Python 3.7, the backend
of keras_ cannot be Tensorflow_.

To install the package in Linux or OS X, enter the following in the console:

Expand All @@ -15,8 +16,7 @@ To install the package in Linux or OS X, enter the following in the console:
It is very possible that you have to do it as root, that you have to add ``sudo`` in
front of the command.

However, the repository on Python Package Index is not always the most updated. To get
the most updated (not official) version, you can install from Github_:
On the other hand, to get the development version on Github, you can install from Github_:

::

Expand All @@ -29,13 +29,50 @@ Before using, check the language model of spaCy has been installed or updated, b

::

spacy download en
python -m spacy download en


Backend for Keras
-----------------

The package keras_ (version >= 2.0.0) uses either Tensorflow_, Theano_, or CNTK_ as the backend, while Theano is usually
the default. However, it is highly recommended to use Tensorflow as the backend.
Users are advised to install the backend `Tensorflow` (preferred) or `Theano` in advance. Refer to
Users are advised to install the backend Tensorflow_ (preferred for Python 2.7, 3.5, and 3.6) or
Theano_ (preferred for Python 3.7) in advance. Refer to
:doc:`faq` for how to switch the backend. It is also desirable if the package Cython_ has been previously installed.


Possible Solutions for Installation Failures
--------------------------------------------

Most developers can install `shorttext` with the instructions above. If the installation fails,
you may try one (or more) of the following:

1. Installing Python-dev by typing:

::

pip install -U python-dev



for Python 2.7, or

::

pip install -U python3-dev


for Python 3.5, 3.6, and 3.7.

2. Installing `gcc` by entering

::

apt-get install libc6



.. _Github: https://github.com/stephenhky/PyShortTextCategorization

Required Packages
Expand Down
8 changes: 8 additions & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
News
====

* 01/30/2019: `shorttext` 1.0.7 released.
* 01/29/2019: `shorttext` 1.0.6 released.
* 01/13/2019: `shorttext` 1.0.5 released.
* 10/03/2018: `shorttext` 1.0.4 released.
Expand Down Expand Up @@ -42,6 +43,13 @@ News
What's New
----------

Release 1.0.7 (January 30, 2019)
--------------------------------

* Compatibility with Python 3.7 with Theano as the backend;
* Minor documentation changes.


Release 1.0.6 (January 29, 2019)
--------------------------------

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def package_description():


setup(name='shorttext',
version="1.0.6",
version="1.0.7",
description="Short Text Mining",
long_description=package_description(),
classifiers=[
Expand Down
2 changes: 1 addition & 1 deletion shorttext/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from . import metrics
from . import spell

__version__ = '1.0.5'
__version__ = '1.0.7'


# to include BERT: refer to:
Expand Down

0 comments on commit 86d8ad2

Please sign in to comment.