Datasets:

ArXiv:
lhbonifacio commited on
Commit
99f149a
1 Parent(s): f0ea384

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -240
README.md CHANGED
@@ -1,248 +1,26 @@
1
- # Git Large File Storage
 
 
2
 
3
- [![CI status][ci_badge]][ci_url]
 
 
4
 
5
- [ci_badge]: https://github.com/git-lfs/git-lfs/workflows/CI/badge.svg
6
- [ci_url]: https://github.com/git-lfs/git-lfs/actions?query=workflow%3ACI
7
-
8
- [Git LFS](https://git-lfs.github.com) is a command line extension and
9
- [specification](docs/spec.md) for managing large files with Git.
10
-
11
- The client is written in Go, with pre-compiled binaries available for Mac,
12
- Windows, Linux, and FreeBSD. Check out the [website](http://git-lfs.github.com)
13
- for an overview of features.
14
-
15
- ## Getting Started
16
-
17
- ### Downloading
18
-
19
- You can install the Git LFS client in several different ways, depending on your
20
- setup and preferences.
21
-
22
- * **Linux users**. Debian and RPM packages are available from
23
- [PackageCloud](https://packagecloud.io/github/git-lfs/install).
24
- * **macOS users**. [Homebrew](https://brew.sh) bottles are distributed, and can
25
- be installed via `brew install git-lfs`.
26
- * **Windows users**. Git LFS is included in the distribution of
27
- [Git for Windows](https://gitforwindows.org/). Alternatively, you can
28
- install a recent version of Git LFS from the [Chocolatey](https://chocolatey.org/) package manager.
29
- * **Binary packages**. In addition, [binary packages](https://github.com/git-lfs/git-lfs/releases) are
30
- available for Linux, macOS, Windows, and FreeBSD.
31
- * **Building from source**. [This repository](https://github.com/git-lfs/git-lfs.git) can also be
32
- built from source using the latest version of [Go](https://golang.org), and the
33
- available instructions in our
34
- [Wiki](https://github.com/git-lfs/git-lfs/wiki/Installation#source).
35
-
36
- ### Installing
37
-
38
- #### From binary
39
-
40
- The [binary packages](https://github.com/git-lfs/git-lfs/releases) include a script which will:
41
-
42
- - Install Git LFS binaries onto the system `$PATH`
43
- - Run `git lfs install` to
44
- perform required global configuration changes.
45
-
46
- ```ShellSession
47
- $ ./install.sh
48
- ```
49
-
50
- #### From source
51
-
52
- - Ensure you have the latest version of Go, GNU make, and a standard Unix-compatible build environment installed.
53
- - On Windows, install `goversioninfo` with `go get github.com/josephspurrier/goversioninfo/cmd/goversioninfo`.
54
- - Run `make`.
55
- - Place the `git-lfs` binary, which can be found in `bin`, on your system’s executable `$PATH` or equivalent.
56
- - Git LFS requires global configuration changes once per-machine. This can be done by
57
- running:
58
-
59
- ```ShellSession
60
- $ git lfs install
61
- ```
62
-
63
- #### Verifying releases
64
-
65
- Releases are signed with the OpenPGP key of one of the core team members. To
66
- get these keys, you can run the following command, which will print them to
67
- standard output:
68
-
69
- ```ShellSession
70
- $ curl -L https://api.github.com/repos/git-lfs/git-lfs/tarball/core-gpg-keys | tar -Ozxf -
71
  ```
72
-
73
- Once you have the keys, you can download the `sha256sums.asc` file and verify
74
- the file you want like so:
75
-
76
- ```ShellSession
77
- $ gpg -d sha256sums.asc | grep git-lfs-linux-amd64-v2.10.0.tar.gz | shasum -a 256 -c
78
  ```
79
 
80
- ## Example Usage
81
-
82
- To begin using Git LFS within a Git repository that is not already configured
83
- for Git LFS, you can indicate which files you would like Git LFS to manage.
84
- This can be done by running the following _from within a Git repository_:
85
 
86
- ```bash
87
- $ git lfs track "*.psd"
88
  ```
89
-
90
- (Where `*.psd` is the pattern of filenames that you wish to track. You can read
91
- more about this pattern syntax
92
- [here](https://git-scm.com/docs/gitattributes)).
93
-
94
- > *Note:* the quotation marks surrounding the pattern are important to
95
- > prevent the glob pattern from being expanded by the shell.
96
-
97
- After any invocation of `git-lfs-track(1)` or `git-lfs-untrack(1)`, you _must
98
- commit changes to your `.gitattributes` file_. This can be done by running:
99
-
100
- ```bash
101
- $ git add .gitattributes
102
- $ git commit -m "track *.psd files using Git LFS"
103
  ```
104
-
105
- You can now interact with your Git repository as usual, and Git LFS will take
106
- care of managing your large files. For example, changing a file named `my.psd`
107
- (tracked above via `*.psd`):
108
-
109
- ```bash
110
- $ git add my.psd
111
- $ git commit -m "add psd"
112
- ```
113
-
114
- > _Tip:_ if you have large files already in your repository's history, `git lfs
115
- > track` will _not_ track them retroactively. To migrate existing large files
116
- > in your history to use Git LFS, use `git lfs migrate`. For example:
117
- >
118
- > ```
119
- > $ git lfs migrate import --include="*.psd" --everything
120
- > ```
121
- >
122
- > For more information, read [`git-lfs-migrate(1)`](https://github.com/git-lfs/git-lfs/blob/main/docs/man/git-lfs-migrate.1.ronn).
123
-
124
- You can confirm that Git LFS is managing your PSD file:
125
-
126
- ```bash
127
- $ git lfs ls-files
128
- 3c2f7aedfb * my.psd
129
- ```
130
-
131
- Once you've made your commits, push your files to the Git remote:
132
-
133
- ```bash
134
- $ git push origin main
135
- Uploading LFS objects: 100% (1/1), 810 B, 1.2 KB/s
136
- # ...
137
- To https://github.com/git-lfs/git-lfs-test
138
- 67fcf6a..47b2002 main -> main
139
- ```
140
-
141
- Note: Git LFS requires at least Git 1.8.2 on Linux or 1.8.5 on macOS.
142
-
143
- ### Uninstalling
144
-
145
- If you've decided that Git LFS isn't right for you, you can convert your
146
- repository back to a plain Git repository with `git lfs migrate` as well. For
147
- example:
148
-
149
- ```ShellSession
150
- $ git lfs migrate export --include="*.psd" --everything
151
- ```
152
-
153
- Note that this will rewrite history and change all of the Git object IDs in your
154
- repository, just like the import version of this command.
155
-
156
- If there's some reason that things aren't working out for you, please let us
157
- know in an issue, and we'll definitely try to help or get it fixed.
158
-
159
- ## Limitations
160
-
161
- Git LFS maintains a list of currently known limitations, which you can find and
162
- edit [here](https://github.com/git-lfs/git-lfs/wiki/Limitations).
163
-
164
- Git LFS source code utilizes Go modules in its build system, and therefore this
165
- project contains a `go.mod` file with a defined Go module path. However, we
166
- do not maintain a stable Go language API or ABI, as Git LFS is intended to be
167
- used solely as a compiled binary utility. Please do not import the `git-lfs`
168
- module into other Go code and do not rely on it as a source code dependency.
169
-
170
- ## Need Help?
171
-
172
- You can get help on specific commands directly:
173
-
174
- ```bash
175
- $ git lfs help <subcommand>
176
- ```
177
-
178
- The [official documentation](docs) has command references and specifications for
179
- the tool. There's also a [FAQ](https://github.com/git-lfs/git-lfs/wiki/FAQ) on
180
- the wiki which answers some common questions.
181
-
182
- If you have a question on how to use Git LFS, aren't sure about something, or
183
- are looking for input from others on tips about best practices or use cases,
184
- feel free to
185
- [start a discussion](https://github.com/git-lfs/git-lfs/discussions).
186
-
187
- You can always [open an issue](https://github.com/git-lfs/git-lfs/issues), and
188
- one of the Core Team members will respond to you. Please be sure to include:
189
-
190
- 1. The output of `git lfs env`, which displays helpful information about your
191
- Git repository useful in debugging.
192
- 2. Any failed commands re-run with `GIT_TRACE=1` in the environment, which
193
- displays additional information pertaining to why a command crashed.
194
-
195
- ## Contributing
196
-
197
- See [CONTRIBUTING.md](CONTRIBUTING.md) for info on working on Git LFS and
198
- sending patches. Related projects are listed on the [Implementations wiki
199
- page](https://github.com/git-lfs/git-lfs/wiki/Implementations).
200
-
201
- See also [SECURITY.md](SECURITY.md) for info on how to submit reports
202
- of security vulnerabilities.
203
-
204
- ## Core Team
205
-
206
- These are the humans that form the Git LFS core team, which runs the project.
207
-
208
- In alphabetical order:
209
-
210
- | [@bk2204][bk2204-user] | [@chrisd8088][chrisd8088-user] | [@larsxschneider][larsxschneider-user] |
211
- | :---: | :---: | :---: |
212
- | [![][bk2204-img]][bk2204-user] | [![][chrisd8088-img]][chrisd8088-user] | [![][larsxschneider-img]][larsxschneider-user] |
213
- | [PGP 0223B187][bk2204-pgp] | [PGP 088335A9][chrisd8088-pgp] | [PGP A5795889][larsxschneider-pgp] |
214
-
215
- [bk2204-img]: https://avatars1.githubusercontent.com/u/497054?s=100&v=4
216
- [chrisd8088-img]: https://avatars1.githubusercontent.com/u/28857117?s=100&v=4
217
- [larsxschneider-img]: https://avatars1.githubusercontent.com/u/477434?s=100&v=4
218
- [bk2204-user]: https://github.com/bk2204
219
- [chrisd8088-user]: https://github.com/chrisd8088
220
- [larsxschneider-user]: https://github.com/larsxschneider
221
- [bk2204-pgp]: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x88ace9b29196305ba9947552f1ba225c0223b187
222
- [chrisd8088-pgp]: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x86cd3297749375bcf8206715f54fe648088335a9
223
- [larsxschneider-pgp]: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xaa3b3450295830d2de6db90caba67be5a5795889
224
-
225
- ### Alumni
226
-
227
- These are the humans that have in the past formed the Git LFS core team, or
228
- have otherwise contributed a significant amount to the project. Git LFS would
229
- not be possible without them.
230
-
231
- In alphabetical order:
232
-
233
- | [@andyneff][andyneff-user] | [@PastelMobileSuit][PastelMobileSuit-user] | [@rubyist][rubyist-user] | [@sinbad][sinbad-user] | [@technoweenie][technoweenie-user] | [@ttaylorr][ttaylorr-user] |
234
- | :---: | :---: | :---: | :---: | :---: | :---: |
235
- | [![][andyneff-img]][andyneff-user] | [![][PastelMobileSuit-img]][PastelMobileSuit-user] | [![][rubyist-img]][rubyist-user] | [![][sinbad-img]][sinbad-user] | [![][technoweenie-img]][technoweenie-user] | [![][ttaylorr-img]][ttaylorr-user] |
236
-
237
- [andyneff-img]: https://avatars1.githubusercontent.com/u/7596961?v=3&s=100
238
- [PastelMobileSuit-img]: https://avatars2.githubusercontent.com/u/37254014?s=100&v=4
239
- [rubyist-img]: https://avatars1.githubusercontent.com/u/143?v=3&s=100
240
- [sinbad-img]: https://avatars1.githubusercontent.com/u/142735?v=3&s=100
241
- [technoweenie-img]: https://avatars3.githubusercontent.com/u/21?v=3&s=100
242
- [ttaylorr-img]: https://avatars2.githubusercontent.com/u/443245?s=100&v=4
243
- [andyneff-user]: https://github.com/andyneff
244
- [PastelMobileSuit-user]: https://github.com/PastelMobileSuit
245
- [sinbad-user]: https://github.com/sinbad
246
- [rubyist-user]: https://github.com/rubyist
247
- [technoweenie-user]: https://github.com/technoweenie
248
- [ttaylorr-user]: https://github.com/ttaylorr
 
1
+ # Dataset Summary
2
+ This repository provides the mMARCO dataset.
3
+ This dataset was created by translating the MS MARCO Passage Ranking dataset into 8 different languages.
4
 
5
+ # Dataset Structure
6
+ You can load mMARCO dataset by choosing a specific language.
7
+ For each language, there are four splits: the first one, called collection, which contains all the dataset passages, followed by three queries splits, regarding to the training, development and evaluation sets.
8
 
9
+ # Load Dataset
10
+ An example to load the dataset:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ```
12
+ dataset = load_dataset('unicamp-dl/mmarco', language='portuguese')
 
 
 
 
 
13
  ```
14
 
 
 
 
 
 
15
 
16
+ # Citation Information
 
17
  ```
18
+ @misc{bonifacio2021mmarco,
19
+ title={mMARCO: A Multilingual Version of the MS MARCO Passage Ranking Dataset},
20
+ author={Luiz Henrique Bonifacio and Israel Campiotti and Vitor Jeronymo and Roberto Lotufo and Rodrigo Nogueira},
21
+ year={2021},
22
+ eprint={2108.13897},
23
+ archivePrefix={arXiv},
24
+ primaryClass={cs.CL}
25
+ }
 
 
 
 
 
 
26
  ```