-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added readme file for bart #95
Open
mosesdaudu001
wants to merge
1
commit into
ivy-llc:main
Choose a base branch
from
mosesdaudu001:readme-for-bart
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
.. image:: https://github.com/unifyai/unifyai.github.io/blob/main/img/externally_linked/logo.png?raw=true#gh-light-mode-only | ||
:width: 100% | ||
:class: only-light | ||
|
||
.. image:: https://github.com/unifyai/unifyai.github.io/blob/main/img/externally_linked/logo_dark.png?raw=true#gh-dark-mode-only | ||
:width: 100% | ||
:class: only-dark | ||
|
||
|
||
.. raw:: html | ||
|
||
<br/> | ||
<a href="https://pypi.org/project/ivy-models"> | ||
<img class="dark-light" style="float: left; padding-right: 4px; padding-bottom: 4px;" src="https://badge.fury.io/py/ivy-models.svg"> | ||
</a> | ||
<a href="https://github.com/unifyai/models/actions?query=workflow%3Adocs"> | ||
<img class="dark-light" style="float: left; padding-right: 4px; padding-bottom: 4px;" src="https://github.com/unifyai/models/actions/workflows/docs.yml/badge.svg"> | ||
</a> | ||
<a href="https://github.com/unifyai/models/actions?query=workflow%3Anightly-tests"> | ||
<img class="dark-light" style="float: left; padding-right: 4px; padding-bottom: 4px;" src="https://github.com/unifyai/models/actions/workflows/nightly-tests.yml/badge.svg"> | ||
</a> | ||
<a href="https://discord.gg/G4aR9Q7DTN"> | ||
<img class="dark-light" style="float: left; padding-right: 4px; padding-bottom: 4px;" src="https://img.shields.io/discord/799879767196958751?color=blue&label=%20&logo=discord&logoColor=white"> | ||
</a> | ||
<br clear="all" /> | ||
|
||
BART | ||
=========== | ||
|
||
`BART <https://arxiv.org/abs/1910.13461>`_ also known as Bidirectional Autoencoder Representations from Transformers is a denoising autoencoder for pretraining | ||
sequence-to-sequence models. It is trained by corrupting text with an arbitrary noising function, and learning a model to reconstruct the original text. | ||
BART uses a standard Transformer-based neural machine translation architecture, which consists of a bidirectional encoder and a left-to-right decoder. | ||
|
||
The encoder takes the corrupted text as input and produces a sequence of hidden states. The decoder then takes these hidden states as input and predicts the original text, | ||
one token at a time. The model is trained to minimize the negative log likelihood of the original text. | ||
BART can be used for a variety of natural language processing tasks, including text generation, translation, and comprehension. | ||
It has been shown to achieve state-of-the-art results on a number of these tasks | ||
|
||
|
||
Getting started | ||
----------------- | ||
|
||
.. code-block:: python | ||
|
||
import ivy | ||
ivy.set_backend("torch") | ||
from ivy_models.bart import BartModel | ||
from ivy_models.bart.config_bart import BartConfig | ||
|
||
# Instantiate bart model | ||
ivy_bart = BartModel(BartConfig) | ||
|
||
The pretrained bart model is now ready to be used, and is compatible with any other PyTorch code | ||
|
||
Citation | ||
-------- | ||
|
||
:: | ||
|
||
@article{ | ||
title={BART: Denoising Sequence-to-Sequence Pre-training for Natural Language Generation, Translation, and Comprehension}, | ||
author={Mike Lewis, Yinhan Liu, Naman Goyal, Marjan Ghazvininejad, Abdelrahman Mohamed, Omer Levy, Ves Stoyanov and Luke Zettlemoyer}, | ||
journal={arXiv preprint arXiv:1910.13461}, | ||
year={2019} | ||
} | ||
|
||
|
||
@article{lenton2021ivy, | ||
title={Ivy: Templated deep learning for inter-framework portability}, | ||
author={Lenton, Daniel and Pardo, Fabio and Falck, Fabian and James, Stephen and Clark, Ronald}, | ||
journal={arXiv preprint arXiv:2102.02886}, | ||
year={2021} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just thought of one small point, could you please add some usage example code (eg, inferencing) for the model?
on reflection, I think some other models readme didn't have this, so could you please double check and update them in another PR? thanks a lot!