https://github.com/catalyst-team/codestyle

https://github.com/catalyst-team/codestyle

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/catalyst-team/codestyle
• Owner: catalyst-team
• License: apache-2.0
• Created: 2020-03-26T10:59:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-24T15:37:24.000Z (almost 5 years ago)
• Last Synced: 2024-11-07T00:17:23.313Z (over 1 year ago)
• Language: Python
• Size: 71.3 KB
• Stars: 7
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Catalyst.Codestyle

[![build](https://github.com/catalyst-team/codestyle/actions/workflows/codestyle.yml/badge.svg)](https://github.com/catalyst-team/codestyle/actions/workflows/codestyle.yml)

[![Pipi version](https://img.shields.io/pypi/v/catalyst-codestyle)](https://pypi.org/project/catalyst-codestyle/)

[![Python Version](https://img.shields.io/pypi/pyversions/catalyst-codestyle)](https://pypi.org/project/catalyst-codestyle/)

[![License](https://img.shields.io/github/license/catalyst-team/codestyle)](LICENSE)

[![Twitter](https://img.shields.io/badge/twitter-news-blue)](https://twitter.com/CatalystTeam)

[![Slack](https://img.shields.io/badge/slack-join_chat-brightgreen)](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw)

[![Telegram](https://img.shields.io/badge/telegram-join_chat-blue)](https://t.me/catalyst_team)

**Catalyst** is an PyTorch framework for Deep Learning research and development.

It was developed with a focus on reproducibility, fast experimentation and code/ideas reusing.

Being able to research/develop something new, rather than write another regular train loop. 


Break the cycle - use the Catalyst!

[Catalyst at AI Landscape](https://landscape.lfai.foundation/selected=catalyst).

## Getting started

```bash

# make code compatible with `catalyst` code style

catalyst-make-codestyle

# check that the code is `catalyst` code style compliant

catalyst-check-codestyle

```

## Installation

You can install `catalyst-codestyle` via pip or directly from source.

### Install from PyPi

Using pip you can easily install the latest release version [PyPI](https://pypi.org/):

```bash

pip install -U catalyst-codestyle

```

### Install from GitHub

You can install the latest development version using pip directly from the GitHub repository:

```bash

pip install git+https://github.com/catalyst-team/codestyle.git

```

### Install from source

It’s also possible to clone the Git repository and install `catalyst-codestyle` using its `setup.py`:

```bash

git clone https://github.com/catalyst-team/codestyle.git

cd codestyle

python setup.py install

```

## Communication

- GitHub Issues: Bug reports, feature requests, install issues, RFCs, thoughts, etc.

- Slack: The [Catalyst Slack](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw) hosts a primary audience of moderate to experienced Catalyst users and developers for general chat, online discussions, collaboration, etc.

- Email: Feel free to use [feedback@catalyst-team.com](mailto:feedback@catalyst-team.com) as an additional channel for feedback.