allenai / word2vecjava

Word2Vec Java Port

Word2vecJava

This is a fork of the open source Java implementation of word2vec (https://github.com/medallia/Word2VecJava) ported to work with SBT, and has some fixes to support large models.

It gets published to Maven Central under package name org.allenai.word2vec.Word2VecJava. All package referenences are changed from com.medallia.word2vec to org.allenai.word2vec in the Java source code.

Building the project and Running tests

To verify that the project is building correctly, run

sbt clean compile
sbt test

It should run 7 tests without any error.

Contact

Sumithra Bhakthavatsalam ([email protected])

Release

This project releases to BinTray. To make a release:

1. Pull the latest code on the master branch that you want to release
2. Edit build.sbt to remove "-SNAPSHOT" from the current version
3. Create a pull request if desired or push to master if you are only changing the version
4. Tag the release git tag -a vX.Y.Z -m "Release X.Y.Z" replacing X.Y.Z with the correct version
5. Push the tag back to origin git push origin vX.Y.Z
6. Release the build on Bintray sbt +publish (the "+" is required to cross-compile)
7. Verify publication on bintray.com
8. Bump the version in build.sbt on master (and push!) with X.Y.Z+1-SNAPSHOT (e.g., 2.5.1 -SNAPSHOT after releasing 2.5.0)

If you make a mistake you can rollback the release with sbt bintrayUnpublish and retag the version to a different commit as necessary.