chore: maintenance updates

.gitignore

@@ -14,3 +14,18 @@ dist/
 
 fasttext/fasttext.cpp
 facebookresearch-fasttext-*
+
+# Intellij
+.idea/
+
+# pip
+.eggs/
+
+# For test
+test/*_result.txt
+test/dbpedia.train
+test/dbpedia_csv/
+test/default_params_test
+
+# Misc
+TODO

.travis.yml

@@ -1,12 +1,17 @@
 language: python
 python:
-  - "2.6"
-  - "2.7"
-  - "3.2"
-  - "3.3"
-  - "3.4"
-  - "3.5"
-
+- '2.6'
+- '2.7'
+- '3.2'
+- '3.3'
+- '3.4'
+- '3.5'
 install: make install
-
 script: make test
+branches:
+  only:
+  - master
+  - /^v\d{,2}\.\d{,3}\.\d{,3}$/
+notifications:
+  slack:
+    secure: pStiYmzBbnb0W18r1i1Lz8FIakVHajsv3on1vWy8fNWVuPfaJ85ZqJhnmrr2HKlanZcl6bEMnllDctzt/F+u4HfeXHmhS7a9nZbRDDGyWIxsvJA/UqPt2byLEB1u+KbLb53eDu7MTIe63tzk1zq+4BTupI+btc4igiUuzAhqh4+LP9eZe2L58aC+jOzIn/9Kno7+xawhj2DKs6m3O/hcXFORcOpdtWRFpoDa66dN7xPVbN0hYD80uVApEpghnHToiJN0HhhB92YmZHa1ByWj7u9VN1Eaex1srGQOJQG3FaDBJY1r2e9c7Sj+33gkZb1AqjeOpxhRsxxVUdigDvCoxIrr6ll0/p3n6pUfRGQ7SB1A7NoRBC+g6aTJbOLr5NjQDBmZHaFXx/QFd1h0EUfgBybDI3v4cKOtV8vIFoT1xdkGs/Hjo4v9z4KO6R135uDBwaJAo9cWx360xV1UK1cb4kfzdbJFk4mNmMEbdwJHT27a7e3uWr1lu6CrMUzVk0EXj1BroKC7jcRK7qthr9DcfW2mmGG3JTIKQ6+nYSEF0KC/JjjbIsg/2hKtq7mACzrHrluN6HbqCF6Kd2n2rfItsqIaCo6LEmgZ2fo69R34i96QzyHpplBivWOgC+pwLOe0FiseuleSCZ/kQgJPf62gsqCan6+GkazoEp9Ow+lPMkA=

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# How to contribute
+
+We definitely welcome patches and contribution to fastText.py!
+
+Here are some guidelines and information about how to do so.
+
+## Sending patches
+
+### Getting started
+
+1. Check out the code:
+
+        $ git clone https://github.com/salestock/fastText.py.git
+        $ cd fastText.py
+        $ pip install -r requirements.txt
+
+1. Create a fork of the fastText.py repository.
+1. Add your fork as a remote:
+
+        $ git remote add fork git@github.com:$YOURGITHUBUSERNAME/fastText.py.git
+
+1. Make changes, commit them.
+1. Run the test suite:
+
+        $ make install-dev
+        $ make test
+
+1. Push your changes to your fork:
+
+        $ git push fork ...
+
+1. Open a pull request.
+
+## Filing Issues
+When filing an issue, make sure to answer these five questions:
+
+1. What version of Python are you using (`python --version`)?
+2. What version of `fasttext` are you using (`pip list |  grep fasttext`)?
+3. What operating system and processor architecture are you using?
+4. What did you do?
+5. What did you expect to see?
+6. What did you see instead?
+
+### Contributing code
+Unless otherwise noted, the fastText.py source files are distributed under
+the BSD-style license found in the LICENSE file.

Makefile

@@ -1,7 +1,7 @@
 
 all: install test
 
-test: test-skipgram test-cbow
+test: test-skipgram test-cbow test-classifier
 
 buildext:
 	python setup.py build_ext --inplace
@@ -12,30 +12,113 @@ install:
 	python setup.py install
 .PHONY: install
 
-install-dev:
+# Install the pandoc(1) first to run this command
+# sudo apt-get install pandoc
+README.rst: README.md
+	pandoc --from=markdown --to=rst --output=README.rst README.md
+
+upload: README.rst
+	python setup.py sdist upload
+
+upload-to-pypitest: README.rst
+	python setup.py sdist upload -r pypitest
+.PHONY: upload-to-pypitest
+
+install-from-pypitest::
+	pip install -U --no-cache-dir -i https://testpypi.python.org/pypi fasttext
+.PHONY: install-from-pypitest
+
+install-dev: README.rst
 	python setup.py develop
 .PHONY: install-dev
 
+pre-test:
+	# Remove generated file from test
+	rm -f test/*.vec test/*.bin test/*_result.txt
+.PHONY: pre-test
+
 fasttext/cpp/fasttext:
 	make --directory fasttext/cpp/
 
 # Test for skipgram model
+# Redirect stdout to /dev/null to prevent exceed the log limit size from
+# Travis CI
 test/skipgram_params_test.bin:
 	./fasttext/cpp/fasttext skipgram -input test/params_test.txt -output \
 		test/skipgram_params_test -lr 0.025 -dim 100 -ws 5 -epoch 1 \
-		-minCount 5 -neg 5 -loss ns -bucket 2000000 -minn 3 -maxn 6 \
-		-thread 4 -lrUpdateRate 100 -t 1e-4
+		-minCount 1 -neg 5 -loss ns -bucket 2000000 -minn 3 -maxn 6 \
+		-thread 4 -lrUpdateRate 100 -t 1e-4 >> /dev/null
+
+# Generate default value of skipgram command from fasttext(1)
+test/skipgram_default_params_result.txt:
+	$(MAKE) skipgram_default_params_result.txt --directory test/
 
-test-skipgram: fasttext/cpp/fasttext test/skipgram_params_test.bin
+test-skipgram: pre-test fasttext/cpp/fasttext test/skipgram_params_test.bin \
+			   test/skipgram_default_params_result.txt
 	python test/skipgram_test.py --verbose
 
 # Test for cbow model
+# Redirect stdout to /dev/null to prevent exceed the log limit size from
+# Travis CI
 test/cbow_params_test.bin:
 	./fasttext/cpp/fasttext cbow -input test/params_test.txt -output \
 		test/cbow_params_test -lr 0.005 -dim 50 -ws 5 -epoch 1 \
-		-minCount 3 -neg 5 -loss ns -bucket 2000000 -minn 3 -maxn 6 \
-		-thread 4 -lrUpdateRate 100 -t 1e-4
+		-minCount 1 -neg 5 -loss ns -bucket 2000000 -minn 3 -maxn 6 \
+		-thread 4 -lrUpdateRate 100 -t 1e-4 >> /dev/null
 
-test-cbow: fasttext/cpp/fasttext test/cbow_params_test.bin
+# Generate default value of cbow command from fasttext(1)
+test/cbow_default_params_result.txt:
+	$(MAKE) cbow_default_params_result.txt --directory test/
+
+test-cbow: pre-test fasttext/cpp/fasttext test/cbow_params_test.bin \
+		   test/cbow_default_params_result.txt
 	python test/cbow_test.py --verbose
 
+# Test for classifier
+test/dbpedia.train: test/download_dbpedia.sh
+	sh test/download_dbpedia.sh # Download & normalize training file
+
+# Redirect stdout to /dev/null to prevent exceed the log limit size from
+# Travis CI
+test/classifier.bin: test/dbpedia.train
+	./fasttext/cpp/fasttext supervised -input test/dbpedia.train \
+		-output test/classifier -dim 100 -lr 0.1 -wordNgrams 2 \
+		-minCount 1 -bucket 2000000 -epoch 5 -thread 4 >> /dev/null
+
+test/classifier_test_result.txt: test/classifier.bin
+	./fasttext/cpp/fasttext test test/classifier.bin \
+		test/classifier_test.txt > test/classifier_test_result.txt
+
+test/classifier_pred_result.txt: test/classifier.bin
+	./fasttext/cpp/fasttext predict test/classifier.bin \
+		test/classifier_pred_test.txt > \
+		test/classifier_pred_result.txt
+
+test/classifier_pred_k_result.txt: test/classifier.bin
+	./fasttext/cpp/fasttext predict test/classifier.bin \
+		test/classifier_pred_test.txt 5 > \
+		test/classifier_pred_k_result.txt
+
+test/classifier_pred_prob_result.txt: test/classifier.bin
+	./fasttext/cpp/fasttext predict-prob test/classifier.bin \
+		test/classifier_pred_test.txt > \
+		test/classifier_pred_prob_result.txt
+
+test/classifier_pred_prob_k_result.txt: test/classifier.bin
+	./fasttext/cpp/fasttext predict-prob test/classifier.bin \
+		test/classifier_pred_test.txt 5 > \
+		test/classifier_pred_prob_k_result.txt
+
+# Generate default value of classifier command from fasttext(1)
+test/classifier_default_params_result.txt:
+	$(MAKE) classifier_default_params_result.txt --directory test/
+
+test-classifier: pre-test fasttext/cpp/fasttext test/classifier.bin \
+				 test/classifier_test_result.txt \
+				 test/classifier_pred_result.txt \
+				 test/classifier_pred_k_result.txt \
+				 test/classifier_pred_prob_result.txt \
+				 test/classifier_pred_prob_k_result.txt \
+				 test/classifier_default_params_result.txt
+	python test/classifier_test.py --verbose
+