<commit_before>[![status](https://travis-ci.org/nifty-swift/Nifty.svg?branch=master)](https://travis-ci.org/nifty-swift/Nifty)
[![codecov](https://codecov.io/gh/nifty-swift/Nifty/branch/master/graph/badge.svg)](https://codecov.io/gh/nifty-swift/Nifty)
![plaforms](https://img.shields.io/badge/platforms-Linux%20%7C%20macOS-lightgrey.svg)
![swift](https://img.shields.io/badge/Swift-4.0-orange.svg?style=flat)
![license](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)

# Nifty

[Nifty](https://github.com/nifty-swift/Nifty) is a general-purpose numerical computing library for the Swift programming language, made with performance and ease-of-use in mind. 

## Getting Started

Not sure if Nifty is what you're looking for? Check out a [simple demo project](https://github.com/nifty-swift/Nifty-demo) or peruse the [documentation](http://nifty-swift.org) to help you decide.

### Installation

There are a number of options when it comes to getting up and running with Nifty. In order of easiness:
- Pull down the [Docker image](https://hub.docker.com/r/niftyswift/nifty/)
- Use the included project file in Xcode
- Install with the Swift Package Manager

Nifty is being developed on Ubuntu and macOS; whatever route you go, make sure your version is up to date. Also, our goal is to stay current as Swift develops, so make sure to [install the latest release](https://swift.org/getting-started/).

##### Docker

The `niftyswift/nifty` repo on Docker Hub comes with Swift and all the libraries installed! It even has a base project already set up, so you can just start coding with Nifty.

If you don't have Docker set up already, go [here](https://docs.docker.com/engine/installation/).

Once Docker is set up, the remaining steps are easy:
- Pull down the image and start the container: `docker run -it niftyswift/nifty` – this will start a shell inside the container, within a preconfigured project folder
- Open an editor and start writing code (e.g. `vi main.swift`)
- Execute `swift run` – this will pull down the Nifty library code, compile your code, and run your executable (e.g. `.build/debug/myapp`)

If you've already got a project on your host machine, you can mount it when you start the container and edit locally, e.g. `docker run -v /home/myapp:/myapp -it niftyswift/nifty`<commit_msg>Update badge to Swift 4.1<commit_after>[![status](https://travis-ci.org/nifty-swift/Nifty.svg?branch=master)](https://travis-ci.org/nifty-swift/Nifty)
[![codecov](https://codecov.io/gh/nifty-swift/Nifty/branch/master/graph/badge.svg)](https://codecov.io/gh/nifty-swift/Nifty)
![plaforms](https://img.shields.io/badge/platforms-Linux%20%7C%20macOS-lightgrey.svg)
![swift](https://img.shields.io/badge/Swift-4.1-orange.svg?style=flat)
![license](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)

# Nifty

[Nifty](https://github.com/nifty-swift/Nifty) is a general-purpose numerical computing library for the Swift programming language, made with performance and ease-of-use in mind. 

## Getting Started

Not sure if Nifty is what you're looking for? Check out a [simple demo project](https://github.com/nifty-swift/Nifty-demo) or peruse the [documentation](http://nifty-swift.org) to help you decide.

### Installation

There are a number of options when it comes to getting up and running with Nifty. In order of easiness:
- Pull down the [Docker image](https://hub.docker.com/r/niftyswift/nifty/)
- Use the included project file in Xcode
- Install with the Swift Package Manager

Nifty is being developed on Ubuntu and macOS; whatever route you go, make sure your version is up to date. Also, our goal is to stay current as Swift develops, so make sure to [install the latest release](https://swift.org/getting-started/).

##### Docker

The `niftyswift/nifty` repo on Docker Hub comes with Swift and all the libraries installed! It even has a base project already set up, so you can just start coding with Nifty.

If you don't have Docker set up already, go [here](https://docs.docker.com/engine/installation/).

Once Docker is set up, the remaining steps are easy:
- Pull down the image and start the container: `docker run -it niftyswift/nifty` – this will start a shell inside the container, within a preconfigured project folder
- Open an editor and start writing code (e.g. `vi main.swift`)
- Execute `swift run` – this will pull down the Nifty library code, compile your code, and run your executable (e.g. `.build/debug/myapp`)

If you've already got a project on your host machine, you can mount it when you start the container and edit locally, e.g. `docker run -v /home/myapp:/myapp -it niftyswift/nifty`
{'fraction_non_alphanumeric': 0.11543422184006878, 'fraction_numerical': 0.003869303525365434, 'mean_word_length': 4.474117647058823, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 24, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3966232', 'n_tokens_mistral': 1568, 'n_tokens_neox': 1460, 'n_words': 533}