Skip to content

Commit

Permalink
Update README.md with pointers to LinkedIn's Artifactory and Maven Ce…
Browse files Browse the repository at this point in the history
…ntral (#9)

* Updated README.md to replace Bintray with Artifactory.
* Added Maven Central documentation.
* Bumped version to 0.3.* to ensure that the latest version of LiFT is valid.
  • Loading branch information
sriramvasudevan committed Mar 31, 2021
1 parent 652fcda commit e629e14
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# The LinkedIn Fairness Toolkit (LiFT)
[![Build Status](https://travis-ci.com/linkedin/LiFT.svg?branch=main)](https://travis-ci.com/linkedin/LiFT)
[![Download](https://api.bintray.com/packages/linkedin/maven/LiFT/images/download.svg)](https://bintray.com/linkedin/maven/LiFT/_latestVersion)
[![Build Status](https://github.com/linkedin/LiFT/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/linkedin/LiFT/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)
[![Release](https://img.shields.io/github/v/release/linkedin/LiFT)](https://github.com/linkedin/LiFT/releases/)
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](LICENSE)
---
> 📣 We've moved from Bintray to [Artifactory](https://linkedin.jfrog.io/artifactory/LiFT/)!
>
> As of version [0.2.2](https://github.com/linkedin/LiFT/releases/tag/v0.2.2), we are only publishing versions
> to LinkedIn's Artifactory instance rather than Bintray, which is approaching end of life.
## Introduction
The LinkedIn Fairness Toolkit (LiFT) is a Scala/Spark library that enables the measurement of fairness and the mitigation of bias in large-scale machine learning workflows.
The measurement module includes measuring biases in training data, evaluating fairness
metrics for ML models, and detecting statistically significant differences in their performance across different
Expand Down Expand Up @@ -89,15 +95,18 @@ To force rebuild the library, you can use:

### Add a LiFT Dependency to Your Project

Please check [Bintray](https://bintray.com/beta/#/linkedin/maven/LiFT) for the latest artifact versions.
Please check [Artifactory](https://linkedin.jfrog.io/artifactory/LiFT/) for the latest artifact versions.

#### Gradle Example

The artifacts are available in JCenter, so you can specify the JCenter repository in the top-level build.gradle file.
The artifacts are available in LinkedIn's Artifactory instance and in Maven Central, so you can specify either repository in the top-level build.gradle file.

```
repositories {
jcenter()
mavenCentral()
maven {
url "https://linkedin.jfrog.io/artifactory/open-source/"
}
}
```

Expand Down
2 changes: 1 addition & 1 deletion version.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Version of the produced binaries.
# The version is inferred by shipkit-auto-version Gradle plugin (https://github.com/shipkit/shipkit-auto-version)
version=0.2.*
version=0.3.*

0 comments on commit e629e14

Please sign in to comment.