maom commited on
Commit
22b4a51
·
verified ·
1 Parent(s): 1a042dc

Clean up some parsing issues with the README

Browse files
Files changed (1) hide show
  1. README.md +30 -25
README.md CHANGED
@@ -141,61 +141,66 @@ This dataset contains 1,881,712 sequences collected from 600 different bacterial
141
 
142
  ### Install HuggingFace Datasets package
143
 
144
- Each subset can be loaded into python using the HuggingFace [datasets] (https://huggingface.co/docs/datasets/index) library. First, from the command line install the 'datsets' library
145
 
146
- $ pip install datasets
147
 
148
  Optionally set the cache directory, e.g.
149
-
150
- $ HF\_HOME=${HOME}/.cache/huggingface/
151
- $ export HF\_HOME
152
 
153
  then, from within python load the datasets library
154
 
155
- \>\>\> import datasets
156
 
157
  ### Load model datasets
158
 
159
  To load one of the IsItABarrel model datasets, use 'datasets.load_datase(...)':
160
 
161
 
162
- \>\>\> dataset \= datasets.load\_dataset(f"rmauder/IsItABarrel", "TMBB_information")
163
 
164
- and the dataset is loaded as a 'datasets.arrow_dataset.Dataset'
165
 
166
- \>\>\> dataset
167
- \<RESULT OF LOADING DATASET MODEL\>
168
 
169
- Which is a column oriented format that can be accessed directly, converted in to a 'pandas.DataFrame', or 'parquet' format, e.g.
170
 
171
- \>\>\> dataset.data.column('\<colum_name\>')
172
- \>\>\> dataset.to\_pandas()
173
- \>\>\> dataset.to\_parquet("dataset.parquet")
174
 
175
  ## Dataset Details
176
- Dataset 1: TMBB_information
177
  This dataset contains a csv file split into test/train/validate sets. Each set contains 13 columns of information about each protein.
178
 
179
- Dataset 2: fasta_files
180
  This dataset contains pointers to fasta files that are already split into test/train/validate sets just like the csv files. Each fasta file contains protein ID, organism, and the fasta sequence of the protein.
181
 
182
- Dataset 3: unsplit_TMBB_information
183
  This dataset contains a full unsplit csv file with information about every TMBB protein. This can be used if anyone would like to test different splits or to filter data further based on organism or TMBB type.
184
 
185
- ### Dataset Description <This dataset contains information like protein_ID and protein type for almost two million transmembrane beta barrel proteins. It contains both known proteins and predicted proteins based on prokaryotic genomes.>
 
186
 
187
  - **Acknowledgements:** Daniel Montezano, Rebecca Bernstein, Matthew M. Copeland, and Joanna S. G. Slusky
188
 
189
  - **License:** agpl-3.0
190
 
191
- ### Dataset Sources - **Repository:** <https://isitabarrel.ku.edu/search> - **Paper:**
192
- Montezano, D., Bernstein, R., Copeland, M. M., & Slusky, J. S. G. (2023).
193
- General features of transmembrane beta barrels from a large database. Proceedings
194
- of the National Academy of Sciences of the United States of America, 120(29), e2220762120.
195
- doi:10.1073/pnas.2220762120>
 
 
 
196
 
197
 
198
- ### Source Data <The source data is set up as a large downloadable file that is not clustered or split into train test validate splits.>
 
199
 
200
  ## Citation
201
  @article{Montezano2023, title = {General features of transmembrane
@@ -206,4 +211,4 @@ This dataset contains a full unsplit csv file with information about every TMBB
206
  Slusky, Joanna S. G.}, year = {2023}, month = jul}
207
 
208
  ## Dataset Card Authors
209
- Ryan Mauder/rmauder@butler.edu
 
141
 
142
  ### Install HuggingFace Datasets package
143
 
144
+ Each subset can be loaded into python using the HuggingFace [datasets](https://huggingface.co/docs/datasets/index) library. First, from the command line install the `datasets` library
145
 
146
+ $ pip install datasets
147
 
148
  Optionally set the cache directory, e.g.
149
+
150
+ $ HF_HOME=${HOME}/.cache/huggingface/
151
+ $ export HF_HOME
152
 
153
  then, from within python load the datasets library
154
 
155
+ >>> import datasets
156
 
157
  ### Load model datasets
158
 
159
  To load one of the IsItABarrel model datasets, use 'datasets.load_datase(...)':
160
 
161
 
162
+ >>> dataset = datasets.load_dataset("rmauder/IsItABarrel", "TMBB_information")
163
 
164
+ and the dataset is loaded as a `datasets.arrow_dataset.Dataset`
165
 
166
+ >>> dataset
167
+ <RESULT OF LOADING DATASET MODEL>
168
 
169
+ Which is a column oriented format that can be accessed directly, converted in to a `pandas.DataFrame`, or `parquet` format, e.g.
170
 
171
+ >>> dataset.data.column('\<colum_name\>')
172
+ >>> dataset.to_pandas()
173
+ >>> dataset.to_parquet("dataset.parquet")
174
 
175
  ## Dataset Details
176
+ Dataset 1: `TMBB_information`
177
  This dataset contains a csv file split into test/train/validate sets. Each set contains 13 columns of information about each protein.
178
 
179
+ Dataset 2: `fasta_files`
180
  This dataset contains pointers to fasta files that are already split into test/train/validate sets just like the csv files. Each fasta file contains protein ID, organism, and the fasta sequence of the protein.
181
 
182
+ Dataset 3: `unsplit_TMBB_information`
183
  This dataset contains a full unsplit csv file with information about every TMBB protein. This can be used if anyone would like to test different splits or to filter data further based on organism or TMBB type.
184
 
185
+ ### Dataset Description
186
+ This dataset contains information like protein_ID and protein type for almost two million transmembrane beta barrel proteins. It contains both known proteins and predicted proteins based on prokaryotic genomes.
187
 
188
  - **Acknowledgements:** Daniel Montezano, Rebecca Bernstein, Matthew M. Copeland, and Joanna S. G. Slusky
189
 
190
  - **License:** agpl-3.0
191
 
192
+ ### Dataset Sources
193
+ - **Repository:** [https://isitabarrel.ku.edu/search](https://isitabarrel.ku.edu/search)
194
+ - **Paper:**
195
+
196
+ Montezano, D., Bernstein, R., Copeland, M. M., & Slusky, J. S. G. (2023).
197
+ General features of transmembrane beta barrels from a large database. Proceedings
198
+ of the National Academy of Sciences of the United States of America, 120(29), e2220762120.
199
+ doi:10.1073/pnas.2220762120
200
 
201
 
202
+ ### Source Data
203
+ The source data is set up as a large downloadable file that is not clustered or split into train test validate splits.
204
 
205
  ## Citation
206
  @article{Montezano2023, title = {General features of transmembrane
 
211
  Slusky, Joanna S. G.}, year = {2023}, month = jul}
212
 
213
  ## Dataset Card Authors
214
+ Ryan Mauder rmauder@butler.edu