Skip to content
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

How to create dataset to train in GPL from normal set of domain specific word docs or pdfs. #3

Open
kingafy opened this issue Apr 13, 2022 · 7 comments

Comments

@kingafy
Copy link

kingafy commented Apr 13, 2022

First of all thanks a lot for bringing out this unique paper. After going through the paper I wanted to try out this approach but am little confused with the initial data to be created for training in GPL. Currently all my domain corpus content are in Word files or pdf and I don't have any labelled data ,As your paper claims it can be used for unlabeled data can you please guide how to create the initial input data to pass through this Method. Also kindly share if you have any pretrained models available to experiment the method?

@kwang2049
Copy link
Member

Hi @kingafy, GPL needs only a corpus.jsonl file (data sample is here) for minimal running.

Specifically, you need three steps:

  1. Prepare your corpus in the same format as this data sample mentioned above;
  2. Put your corpus.jsonl under a folder, e.g. named as "generated" for data loading and data generation by GPL;
  3. Call gpl.train with the folder path as an input argument:
python -m gpl.train \
    --path_to_generated_data "generated" \
    --output_dir "output"

I will include more explanations about this in the readme in the future.

@junefeld
Copy link

I get this error:

  File "train.py", line 9, in <module>
    queries_per_passage=-1)
  File "E:\Data_Science\virtual_envs\py36\lib\site-packages\gpl\train.py", line 124, in train
    corpus, gen_queries, gen_qrels = GenericDataLoader(path_to_generated_data).load(split="train")
  File "E:\Data_Science\virtual_envs\py36\lib\site-packages\beir\datasets\data_loader.py", line 63, in load
    self.check(fIn=self.query_file, ext="jsonl")
  File "E:\Data_Science\virtual_envs\py36\lib\site-packages\beir\datasets\data_loader.py", line 30, in check
    raise ValueError("File {} not present! Please provide accurate file.".format(fIn))
ValueError: File generated\queries.jsonl not present! Please provide accurate file.

Script:

import gpl

#dataset = 'fiqa'
gpl.train(path_to_generated_data="generated",
          output_dir="output",
          mnrl_output_dir="output",
          mnrl_evaluation_output="output",
          new_size=-1,
          queries_per_passage=-1)

generated data comes from the suggested example (only corpus.jsonl in the folder).

@junefeld
Copy link

junefeld commented Jun 8, 2022

anyone have any luck?

@kwang2049
Copy link
Member

Hi @christopherfeld, could you please try this toy example: #5 (comment) and let me know whether it is runnable in your case?

@junefeld
Copy link

No luck. To give some baseline...

I tried your code from April 14, above to no avail. I tried the toy example from the comment above to no avail.

My folder structure looks like this:

  • corpus/corpus.jsonl
  • generated (empty)
  • output (empty)

code (per your request: #5 (comment)):
python -m gpl.train --path_to_generated_data "generated/" --base_ckpt "distilbert-base-uncased" --gpl_score_function "dot" --batch_size_gpl 4 --gpl_steps 100 --new_size 10 --queries_per_passage 1 --output_dir "output/corpus.jsonl" --evaluation_data "corpus" --evaluation_output "evaluation/corpus.jsonl" --generator "BeIR/query-gen-msmarco-t5-base-v1" --retrievers "msmarco-distilbert-base-v3" "msmarco-MiniLM-L-6-v3" --retriever_score_functions "cos_sim" "cos_sim" --cross_encoder "cross-encoder/ms-marco-MiniLM-L-6-v2" --qgen_prefix "qgen"

Resultant Error:
image

Thoughts:
Got me thinking that the qgen prefix might be the issue so placed that to "", which still adds a '-'...'. Tried to rerun the code after rename the outputs in the generated folder to remove the qgen and -... then ran into an index error:
image

@kwang2049
Copy link
Member

Hi @christopherfeld, I have created a google colab notebook showing the running results of the toy example: https://colab.research.google.com/drive/1Wis4WugIvpnSAc7F7HGBkB38lGvNHTtX?usp=sharing Please have a look:).

BTW, I think the error might be due to the export command does not work on windows (I am not really familiar with windows).

@junefeld
Copy link

thanks! I ran this on my personal M1 and it works! Now am just waiting on my work Mac to get here :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants