Skip to content

Latest commit

 

History

History
128 lines (86 loc) · 8.14 KB

README.md

File metadata and controls

128 lines (86 loc) · 8.14 KB
Raw

Accord.NET Framework

DOI Build status Build Status NuGet Downloads License NuGet NuGet Pre Release

The Accord.NET project provides machine learning, statistics, artificial intelligence, computer vision and image processing methods to .NET. It can be used on Microsoft Windows, Xamarin, Unity3D, Windows Store applications, Linux or mobile.

After merging with the AForge.NET project, the framework now offers a unified API for learning/training machine learning models that is both easy to use and extensible. It is based on the following pattern:

For more information, please see the getting started guide, and check the classfication wiki. Please do not hesitate to edit the wiki if you would like!

Installing

To install the framework in your application, please use NuGet. If you are on Visual Studio, right-click on the "References" item in your solution folder, and select "Manage NuGet Packages." Search for Accord.MachineLearning (or equivalently, Accord.Math, Accord.Statistics or Accord.Imaging depending on your initial goal) and select "Install."

If you would like to install the framework on Unity3D applications, download the "libsonly" compressed archive from the framework releases page. Navigate to the Releases/Mono folder, and copy the .dll files to the Plugins folder in your Unity project. Finally, find and add the System.ComponentModel.DataAnnotations.dll assembly that should be available from your system to the Plugin folders as well.

Sample applications

The framework comes with a wide range of sample applications to help get you started quickly. If you downloaded the framework sources or cloned the repository, open the Samples.sln solution file in the Samples folder.

Building

With Visual Studio 2015

Please download and install the following dependencies:

Then navigate to the Sources directory, and open the Accord.NET.sln solution file. Note: the solution includes F# unit test projects that can be disabled/unloaded from the solution in case you do not have support for F# tools in your version of Visual Studio.

With Visual Studio 2017

Please download and install the following dependencies:

Then navigate to the Sources directory, and open the Accord.NET.sln solution file. Note: the solution includes F# unit test projects that can be disabled/unloaded from the solution in case you do not have support for F# tools in your version of Visual Studio.

With Mono in Linux

# Install Mono
sudo apt-get install mono-complete monodevelop monodevelop-nunit git autoconf make

# Clone the repository
git clone https://github.com/accord-net/framework.git

# Enter the directory
cd framework

# Build the framework solution using Mono
./autogen.sh
make build
make samples
make test

With Mono in OS X

# Install Mono
brew update
brew cask install mono-mdk pkg-config automake

# Clone the repository
git clone https://github.com/accord-net/framework.git

# Enter the directory
cd framework

# Set some environment variables with OSX-specific paths
export PKG_CONFIG_PATH=/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/
export MONO=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono
export XBUILD=/Library/Frameworks/Mono.framework/Versions/Current/bin/xbuild

# Build the framework solution using Mono
./autogen.sh
make build
make samples
make test

Contributing

If you would like to contribute, please do so by helping us update the project's Wiki pages. While you could also make a donation through PayPal Donate, Flattr Flattr this git repo, or any of the cryptocurrencies shown below, as well as fill-in bug reports and contribute code in the form of pull requests, the most precious donation we could receive would be a bit of your time - please take some minutes to submit us more documentation examples to our Wiki pages 😉

Donate using cryptocurrencies:

  • BTC: 1FC5gxLs2TsvuiHPP1tRLh5mPboQJQghvZ
  • ETH: 0x36FDA635Ef5773d8B376037D7BAfF22FeB987d92
  • LTC: LNjkZkMdSyncUvg5WnnhDNirdux4Q95gdt

Note: all donations are 100% invested towards improving the framework, including, but not limited to, the hiring of extra developers to work on issues currently present at the project's issue tracker. If you would like to donate resources towards the development of a particular issue, please let us know!

Join the chat at https://gitter.im/accord-net/framework - but to have issues and questions answered, post it as an issue.

Citing

Please cite this work as:

@misc{souza2014accord,
  title={The Accord.NET Framework},
  author={C{\'e}sar Souza and Andrew Kirillov and Marcos Diego Catalano and Accord.NET contributors},
  year={2014},
  doi={10.5281/zenodo.1029480},
  url={http://accord-framework.net}
}

[bibtex]