Code Monkey home page Code Monkey logo

website's Introduction

Jubatus Website

About

This repository holds Sphinx source files for http://jubat.us/ website.

Contributions are always welcomed, from tiny typos to enhancements. Feel free to make pull-requests to this repository.

Requirements

  • Python 2.7 + Sphinx 1.4.3 + blockdiag + sphinx_rtd_theme

Easy setup for Ubuntu 16.04 systems:

# apt-get install python-sphinx latex-cjk-japanese texlive-latex-extra dvipng
# pip install sphinxcontrib-blockdiag sphinxcontrib-rubydomain sphinx_rtd_theme

How to Edit

First of all, clone this repository (if you don't have a commit access, use your fork).

$ git clone [email protected]:jubatus/website.git

Edit the document.

$ edit source/index.rst

Build and preview the changes you made.

$ omake html
$ open build/html/index.html

Looks good? Now, push it.

$ git push origin master

Then open a pull-request.

For Jubatus members: you can deploy it to http://jubat.us/ website.

$ ./publish.sh

How to Build using Docker

$ docker build -t website-builder .
$ docker run --rm -v $PWD:/data website-builder

Copyright

(C) PFN & NTT

website's People

Contributors

beam2d avatar delta2323 avatar gintenlabo avatar gwtnb avatar hido avatar hillbig avatar imaimai1125 avatar inohiro avatar kentaro avatar kmaehashi avatar komainu8 avatar kuenishi avatar kumagi avatar luomin avatar murasehiroaki avatar odasatoshi avatar rimms avatar sakuraikaito avatar shiodat avatar sudoyu avatar suma avatar t-abe avatar tanakh avatar tkrudagawa avatar torash avatar unnonouno avatar y-oda-oni-juba avatar ytobe avatar yukimori avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

website's Issues

update building requirements Python 2.4

In the next release, Jubats building requirements is Python 2.4 and later:
jubatus/jubatus#296

I wrote what Python version requires (and needs update web):

Web master(needs fix?) develop 0.4.3(needs fix?)
Requirements 2.6 and later 2.4 and later(fix)
FAQ 2.6 and later(fix) will be removed?(fix)
Client version 2.7 2.7

Is FAQ necessary to delete in the develop(next release)?

document more on how to develop plugins

  • Document is obsolete (word_splitter::split is now const).
  • Currently, only word_splitter is documented. string_filter, num_feature, num_filter must be documented.

Add description of algorithm detail

Recover method.rst which removed e76c51f and add more method's algorithm description.


  • PA(PA, PA1, PA2): Passive Aggressive
    • Koby Crammer, Ofer Dekel, Shai Shalev-Shwartz and Yoram Singer, Online Passive-Aggressive Al- gorithms, Proceedings of the Sixteenth Annual Conference on Neural Information Processing Systems (NIPS), 2003.
    • Koby Crammer, Ofer Dekel, Joseph Keshet, Shai Shalev-Shwartz, Yoram Singer, Online Passive- Aggressive Algorithms. Journal of Machine Learning Research, 2006.
    • Koby Crammer and Yoram Singer. Ultraconservative online algorithms for multiclass problems. Journal of Machine Learning Research, 2003.
  • CW: Confidence Weighted Learning
    • MarkDredze,KobyCrammerandFernandoPereira,Confidence-WeightedLinearClassification,Proceed- ings of the 25th International Conference on Machine Learning (ICML), 2008
    • Koby Crammer, Mark Dredze and Fernando Pereira, Exact Convex Confidence-Weighted Learning, Pro- ceedings of the Twenty Second Annual Conference on Neural Information Processing Systems (NIPS), 2008
    • KobyCrammer,MarkDredzeandAlexKulesza,Multi-ClassConfidenceWeightedAlgorithms,Empirical Methods in Natural Language Processing (EMNLP), 2009
  • AROW: Adaptive Regularization of Weight vectors
    • Koby Crammer, Alex Kulesza and Mark Dredze, Adaptive Regularization Of Weight Vectors, Advances in Neural Information Processing Systems, 2009
  • NHERD: Normal Herd
    • Koby Crammer and Daniel D. Lee, Learning via Gaussian Herding, Neural Information Processing Systems (NIPS), 2010.

Write project member information, and project policy

We need to write more project information in website about:

  • Project goal
  • Project owner, member, maintainer
  • Project roadmap/milestone (current development status)
  • OSS policy for contribution or inquiry, and openness of the dev-community

The Python sample program has ImportError

URL:
http://jubat.us/ja/tutorial/anomaly_python.html

There are [import] statements in [anomaly.py] :
from anomaly import client
from anomaly import types

These [import] statements cause the following error:
ImportError: cannot import name client

When I changed the import statements to:
from jubatus.anomaly import client
from jubatus.anomaly import types

The ImportError was disappeared, and [anomaly.py] was rightly executed.

Fix URI of repositories in turorial

In source/tutorial.rst,

git clone [email protected]:jubatus/jubatus.git

and

git clone [email protected]:jubatus/jubatus-python.git

should be replaced with read-only git-URIs as follows.

git://github.com/jubatus/jubatus.git
git://github.com/jubatus/jubatus-python-client.git

This changes allows users who are trying the tutorial and aren't the member of jubatus project to clone the repositories.

Fix anomaly tutorial

Explanations for jubaanomaly (LOF) and its results are incorrect.

Need to correct it and update the tutorial source code for all languages.

write "System overview"

Currently we have docs about the interface and how to use, but are still lacking in the architecture overview and how it works.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.