|
| 1 | +# Kalimdor.js |
| 2 | + |
| 3 | +Kalimdor.js is a Machine Learning library written in Typescript. It solves Machine Learning problems |
| 4 | +and teaches users how Machine Learning algorithms work. |
| 5 | + |
| 6 | +[](https://ci.appveyor.com/project/JasonShin/kalimdorjs/branch/master) |
| 7 | +[](https://app.fossa.io/projects/git%2Bgithub.com%2FJasonShin%2Fkalimdorjs?ref=badge_shield) |
| 8 | +[](https://slack.bri.im) |
| 9 | + |
| 10 | +<img src="https://i.imgur.com/CpZA2U7.png"> |
| 11 | + |
| 12 | +# User Installation |
| 13 | + |
| 14 | +Using yarn |
| 15 | + |
| 16 | +```bash |
| 17 | +$ yarn add machinelearn-node |
| 18 | +``` |
| 19 | + |
| 20 | +Using NPM |
| 21 | + |
| 22 | +```bash |
| 23 | +$ npm install --save machinelearn-node |
| 24 | +``` |
| 25 | + |
| 26 | +Then you should require the package in your project |
| 27 | + |
| 28 | +```javascript |
| 29 | +require('machinelearn-node'); |
| 30 | +``` |
| 31 | + |
| 32 | +# Accelerations |
| 33 | + |
| 34 | +By default, machinelearning.js will use pure Javascript version of tfjs. To enable acceleration |
| 35 | +through C++ binding or GPU, you must |
| 36 | + |
| 37 | +# Highlights |
| 38 | + |
| 39 | +- Machine Learning on the browser and Node.js |
| 40 | +- Learning APIs for users |
| 41 | +- Low entry barrier |
| 42 | + |
| 43 | +# Development |
| 44 | + |
| 45 | +We welcome new contributors of all level of experience. The development guide will be added |
| 46 | +to assist new contributors to easily join the project. |
| 47 | + |
| 48 | +- You want to participate in a Machine Learning project, which will boost your Machine Learning skills and knowledge |
| 49 | +- Looking to be part of a growing community |
| 50 | +- You want to learn Machine Learning |
| 51 | +- You like Typescript :heart: Machine Learning |
| 52 | + |
| 53 | +# Testing |
| 54 | + |
| 55 | +Testing ensures you that you are currently using the most stable version of Kalimdor.js |
| 56 | + |
| 57 | +```bash |
| 58 | +$ npm run test |
| 59 | +``` |
| 60 | + |
| 61 | +# Supporting |
| 62 | + |
| 63 | +Simply give us a :star2: by clicking on <img width="45" src="https://i.imgur.com/JEOaKBk.png"> |
| 64 | + |
| 65 | +# Contributing |
| 66 | + |
| 67 | +We simply follow "fork-and-pull" workflow of Github. Please read CONTRIBUTING.md for more detail. |
0 commit comments