Logo

Tutorials & Explanations

  • ParlAI Quick-start
    • Colab Tutorial
    • Install
    • View a task & train a model
    • Train a Transformer on Twitter
    • Add a simple model
    • Conclusion
  • Intro to ParlAI
    • What is ParlAI?
    • Core Concepts
      • Agents
      • Messages
      • Teachers
      • Worlds
    • Using ParlAI
      • Concepts in Action: Simple Display Data Script
      • Validation and Testing
      • Tasks
      • Training and Evaluating Existing Agents
      • Interacting with Models
  • Tasks and Datasets in ParlAI
    • Quickstart: Adding a new dataset
      • Handling Separate Train/Valid/Test data
      • Json file format (instead of text file format)
    • Creating a new task: the more complete way
      • Part 1: Building the Data
      • Part 2: Creating the Teacher
        • Which base teacher should I use?
        • ParlAIDialogTeacher
        • DialogTeacher
        • Chunk Teacher
        • Task from Scratch
      • Part 3: Add Task to Task List
      • Part 4: Executing the Task
  • Worlds, Sharing & Batching
    • Introduction
    • Agent Sharing
    • Batching
    • Dynamic Batching
  • Using Torch Generator Agent
    • Example Models
    • Creating a Model
    • Tutorial
      • Extending TorchGeneratorAgent
      • Extending TorchGeneratorModel
      • Creating the encoder
      • Creating the decoder
      • Training
  • Using Torch Ranker Agent
    • Example Models
    • Creating a Model
    • Training a Model
      • Setting --candidates
      • Tracking ranking metrics
    • Evaluating a Model
      • Evaluating on a fixed candidate set
      • Evaluating on “vocab” candidates
  • Understanding and adding new metrics
    • Introduction and Standard Metrics
      • Agent-specific metrics
    • Adding custom metrics
    • Teacher metrics
    • Agent (model) level metrics
      • Global metrics
      • Local metrics
  • Speeding up training
    • Setting a baseline
    • Skip generation
    • Dynamic batching
    • FP16
    • Use multiple GPUs
  • Using Mechanical Turk
    • Example Tasks
      • Task 1: Collecting Data
      • Task 2: Evaluating a Dialog Model
      • Task 3: Multi-Agent Dialog
      • Task 4: Advanced Functionality - Deal or No Deal
      • Task 5: Advanced Functionality - MTurk Qualification Flow
      • Task 6: Advanced Functionality - React Task Demo
    • Creating Your Own Task
    • Advanced Task Techniques
      • Custom Frontend Components
      • Displaying Task Context
    • Running a Task
    • Handling Turker Disconnects
    • Reviewing Turker’s Work
    • ParlAI-MTurk Tips and Tricks
      • Approving Work
      • Rejecting Work
      • Filtering Workers
      • Soft-blocking vs. Hard-blocking
      • Preventing and Handling Crashes
      • Task Design
      • Other Tips
    • ParlAI-MTurk Alpha Functionality
      • Running the ParlAI-MTurk Webapp
      • Testing a task in the webapp
      • Reviewing tasks in the webapp
      • Saving and Loading data via the database
    • Additional Credits
  • Using Chat Services
    • Overview
    • Example Tasks
      • Creating your Own Task
    • Available Chat Services
      • Browser
        • Setup
      • Facebook Messenger
        • Setup
      • Terminal
        • Setup
      • Web Sockets
      • Adding a New Chat Service
  • Tests in ParlAI
    • Running a Test
    • Writing a Test
      • Continuous Integration, Explained
      • Types of Tests in ParlAI
        • Unit Tests
        • Data Tests
        • Task Tests
        • Nightly Tests
      • Writing a Test
        • Common Testing Utilities
        • Integration Testing Teachers
        • Writing your own Unit Test
      • Running Your Test

FAQ & Troubleshooting

  • Frequently Asked Questions
  • Tips and Tricks
    • Command line tool
    • Multi-tasking with weighted tasks
    • Tasks with Parameters
    • Self-Chats
    • Prettifying Display of Chats
    • Internal Agents, Tasks and More
    • Contributing
      • Overview
      • Creating a Pull Request
      • Reviewing and Testing
      • Celebrate

Agents, Tasks & Zoo

  • Standard Agents
    • ALICE Bot
      • Setup
    • BART
      • Basic Examples
        • Train BART on convai2.
        • Interact with a BART Model fine-tuned in fairseq
      • BartAgent Options
      • TransformerGeneratorAgent Options
    • BERT Classifier
      • Basic Examples
      • BertClassifierAgent Options
      • BertDictionaryAgent Options
    • BERT Ranker
      • Content
      • Preliminary
      • Basic Examples
      • BiEncoderRankerAgent Options
      • CrossEncoderRankerAgent Options
    • DrQA
      • Basic Examples
      • DictionaryAgent Options
      • DrqaAgent Options
      • SimpleDictionaryAgent Options
    • Examples
      • Basic Examples
    • Fixed Response
      • Basic Examples
      • FixedResponseAgent Options
    • HRED Agent
      • HredAgent Options
    • Hugging Face
      • GPT2
        • Examples
      • DialoGPT
        • Examples
    • Image+Seq2Seq
      • Basic Examples
      • DictionaryAgent Options
      • ImageSeq2seqAgent Options
      • TransformerGeneratorAgent Options
    • IR Baseline
      • Basic Examples
      • DictionaryAgent Options
      • IrBaselineAgent Options
    • Local Human
      • Basic Examples
      • LocalHumanAgent Options
    • MemNN
      • Basic Examples
      • MemnnAgent Options
    • Random Candidate
      • Basic Examples
      • RandomCandidateAgent Options
    • Repeat Label
      • Basic Examples
      • RepeatLabelAgent Options
    • Repeat Query
      • Basic Examples
    • Retriever Reader
      • Basic Examples
      • RetrieverReaderAgent Options
    • Safe Local Human
      • Basic Examples
      • LocalHumanAgent Options
      • SafeLocalHumanAgent Options
    • Seq2Seq Agent
      • Seq2seqAgent Options
    • Starspace
      • Basic Examples
      • DictionaryAgent Options
      • StarspaceAgent Options
    • Test Agents
      • MockTorchAgent Options
      • SilentTorchAgent Options
    • TFIDF Retriever
      • Basic Examples
      • TfidfRetrieverAgent Options
    • Transformer
      • Agent Variations
      • TransformerClassifierAgent Options
      • TransformerGeneratorAgent Options
      • TransformerRankerAgent Options
    • Unigram Agent
      • Basic Examples
      • DictionaryAgent Options
      • UnigramAgent Options
  • Tasks
    • QA Tasks
      • AmazonQA
      • AQuA
      • bAbI 1k
      • bAbI 10k
      • Conversational Question Answering Challenge
      • HotpotQA
      • MCTest
      • Movie Dialog QA
      • Movie Dialog Recommendations
      • MTurk WikiMovies
      • NarrativeQA
      • Natural Questions
      • Question Answering in Context
      • Simple Questions
      • SQuAD2
      • SQuAD
      • TriviaQA
      • Web Questions
      • WikiMovies
      • WikiQA
      • InsuranceQA
      • MS_MARCO
      • QAngaroo
      • ELI5
      • DREAM
      • C3
      • CommonSenseQA
    • Cloze Tasks
      • BookTest
      • Children’s Book Test (CBT)
      • QA CNN
      • QA Daily Mail
    • Goal Tasks
      • Coached Conversational Preference Elicitation
      • Dialog Based Language Learning: bAbI Task
      • Dialog Based Language Learning: WikiMovies Task
      • Dialog bAbI
      • Dialog bAbI+
      • MutualFriends
      • Movie Dialog QA Recommendations
      • Personalized Dialog Full Set
      • Personalized Dialog Small Set
      • Task N’ Talk
      • SCAN
      • MultiWOZ 2.0
      • MultiWOZ 2.1
      • OneCommon
      • AirDialogue
      • ReDial
      • GoogleSGD
      • TaskMaster2
    • ChitChat Tasks
      • Blended Skill Talk
      • Cornell Movie
      • Dialogue NLI
      • DSTC7 subtrack 1 - ubuntu
      • Movie Dialog Reddit
      • Open Subtitles
      • Ubuntu
      • ConvAI2
      • ConvAI_ChitChat
      • Persona-Chat
      • TaskMaster-1-2019
      • Twitter
      • ConvAI2_wild_evaluation
      • Image_Chat
      • Image_Chat_Generation
      • Wizard_of_Wikipedia
      • Wizard_of_Wikipedia_Generator
      • Daily Dialog
      • Empathetic Dialogues
      • Image Grounded Conversations
      • Holl-E
      • ReDial
      • Style-Controlled Generation
    • Negotiation Tasks
      • Deal or No Deal
    • Visual Tasks
      • FVQA
      • VQAv1
      • VQAv2
      • VisDial
      • MNIST_QA
      • CLEVR
      • nlvr
      • Flickr30k
      • COCO_Captions
      • Personality_Captions
      • Image_Chat
      • Image_Chat_Generation
      • Image Grounded Conversations
    • decanlp Tasks
      • MultiNLI
      • IWSLT14
      • ConvAI_ChitChat
      • SST Sentiment Analysis
      • CNN/DM Summarisation
      • QA-SRL Semantic Role Labeling
      • QA-ZRE Relation Extraction
      • WOZ restuarant reservation (Goal-Oriented Dialogue)
      • WikiSQL semantic parsing task
      • MWSC pronoun resolution
  • Model Zoo
    • Squad models
      • Drqa Squad Model
    • Wikipedia models
      • Wikipedia Retriever (Used For Open Squad)
      • Wikipedia Retriever (Used For Wizard Of Wikipedia)
    • Wizard Of Wikipedia models
      • Wizard Of Wikipedia (End To End Generator)
      • Wizard Of Wikipedia (Full Dialogue Retrieval Model)
      • Imageseq2Seq Dodecadialogue Wizard Of Wikipedia Ft Model
      • Unlikelihood Wizard Of Wikipedia Context And Label Repetition Model
      • Unlikelihood Wizard Of Wikipedia Context Repetition Model
      • Unlikelihood Wizard Of Wikipedia Label Repetition Model
    • Light Dialog models
      • Light Bert-Biranker Dialogue Model
      • Imageseq2Seq Dodecadialogue Light Dialogue Ft Model
    • Convai2 models
      • Controllable Dialogue Convai2 Model
      • Poly-Encoder Transformer Convai2 Model
      • Bi-Encoder Transformer Convai2 Model
      • Imageseq2Seq Dodecadialogue Convai2 Ft Model
      • Unlikelihood Convai2 Context And Label Repetition Model
      • Unlikelihood Convai2 Context Repetition Model
      • Unlikelihood Convai2 Label Repetition Model
      • Unlikelihood Vocab Alpha 1E0 Model
      • Unlikelihood Vocab Alpha 1E1 Model
      • Unlikelihood Vocab Alpha 1E2 Model
      • Unlikelihood Vocab Alpha 1E3 Model
    • Personality Captions models
      • Transresnet (Resnet 152) Personality-Captions Model
    • Pretrained Transformers models
      • Poly-Encoder Transformer Reddit Pretrained Model
      • Poly-Encoder Transformer Wikipedia/Toronto Books Pretrained Model
      • Bi-Encoder Transformer Reddit Pretrained Model
      • Bi-Encoder Transformer Wikipedia/Toronto Books Pretrained Model
      • Cross-Encoder Transformer Reddit Pretrained Model
      • Cross-Encoder Transformer Wikipedia/Toronto Books Pretrained Model
    • Image Chat models
      • Transresnet (Resnet152) Image-Chat Model
      • Imageseq2Seq Dodecadialogue Image Chat Ft Model
    • Self Feeding models
      • Self-Feeding Chatbot
    • Dialogue Safety models
      • Transformer Classifier Single-Turn Dialogue Safety Model
      • Bert Classifier Multi-Turn Dialogue Safety Model
    • Integration Tests models
      • Integration Test Models
    • #Dodeca models
      • Imageseq2Seq Dodecadialogue All Tasks Mt Model
      • Imageseq2Seq Dodecadialogue Base Model
    • Cornell Movie models
      • Imageseq2Seq Dodecadialogue Cornell Movie Ft Model
    • Dailydialog models
      • Imageseq2Seq Dodecadialogue Dailydialog Ft Model
    • TBD models
      • Imageseq2Seq Dodecadialogue Eli5 Ft Model
      • Imageseq2Seq Dodecadialogue Pushshift.Io Reddit Ft Model
    • Empathetic Dialogues models
      • Imageseq2Seq Dodecadialogue Empathetic Dialogue Ft Model
    • Igc models
      • Imageseq2Seq Dodecadialogue Image Grounded Conversations Ft Model
    • Twitter models
      • Imageseq2Seq Dodecadialogue Twitter Ft Model
    • Ubuntu models
      • Imageseq2Seq Dodecadialogue Ubuntu V2 Ft Model
    • Blended Skill Talk models
      • Blendedskilltalk: Blendedskilltalk Single-Task Model
      • Blendedskilltalk: Convai2 Single-Task Model
      • Blendedskilltalk: Empatheticdialogues Single-Task Model
      • Blendedskilltalk: Wizard Of Wikipedia Single-Task Model
      • Blendedskilltalk: Mt Single-Skills Model
      • Blendedskilltalk: Mt Single-Skills Model Fine-Tuned On Bst
      • Blender 90M
      • Blender 2.7B
      • Blender 9.4B
    • Pushshift.Io models
      • Tutorial Transformer Generator
      • Reddit 2.7B
      • Reddit 9.4B
    • Wikipedia Plus Toronto Books models
      • Bart
    • Eli5 models
      • Unlikelihood Eli5 Context And Label Repetition Model
      • Unlikelihood Eli5 Context Repetition Model
      • Unlikelihood Eli5 Label Repetition Model
    • Style Gen models
      • Style-Controlled Generation: C75-D+ Generator
    • N/A models
      • Faster-R-Cnn Detectron Features
    • Pretrained Word Embeddings
    • BERT

Scripts & CLI

  • Main scripts
    • display_data
      • Examples
      • CLI Arguments
    • display_model
      • Examples
      • CLI Arguments
    • eval_model
      • Examples
      • CLI Arguments
    • interactive
      • Examples
      • CLI Arguments
    • safe_interactive
      • CLI Arguments
    • self_chat
      • CLI Arguments
    • train_model
      • Examples
      • CLI Arguments
    • vacuum
      • CLI Arguments
  • Advanced Scripts
    • build_candidates
      • Examples
      • CLI Arguments
    • build_dict
      • Examples
      • CLI Arguments
    • convert_to_parlai
      • Examples
      • CLI Arguments
    • convo_render
      • CLI Arguments
    • data_stats
      • Examples
      • CLI Arguments
    • detect_offensive
      • Examples
      • CLI Arguments
    • eval_wordstat
      • Examples
      • CLI Arguments
    • extract_image_feature
      • Examples
      • CLI Arguments
    • interactive_web
      • Examples
      • CLI Arguments
    • multiprocessing_eval
      • Examples
      • CLI Arguments
    • multiprocessing_train
      • Examples
      • CLI Arguments
    • party
      • Examples
      • CLI Arguments
    • profile_interactive
      • CLI Arguments
    • profile_train
      • Examples
      • CLI Arguments
    • verify_data
      • Examples
      • CLI Arguments
  • Writing Your Own Script
    • Custom ParlAI Script
      • ParlaiScript
        • setup_args
        • run
      • Registering a Script
      • Running a script
        • Command Line
        • Import and Run with Args
        • Import and Run with Kwargs

API Reference

  • parlai.chat_service
    • Chat Service Core
      • parlai.chat_service.core.agents
      • parlai.chat_service.core.core.chat_service_manager
      • parlai.chat_service.core.socket
      • parlai.chat_service.core.world_runner
    • Services
      • Browser Chat
        • parlai.chat_service.services.browser_chat.agents
        • parlai.chat_service.services.browser_chat.browser_manager
      • Messenger
        • parlai.chat_service.services.messenger.agents
        • parlai.chat_service.services.messenger.message_sender
        • parlai.chat_service.services.messenger.messenger_manager
        • parlai.chat_service.services.messenger.worlds
      • Terminal Chat
        • parlai.chat_service.services.terminal_chat.agents
        • parlai.chat_service.services.terminal_chat.terminal_manager
      • Websocket
        • parlai.chat_service.services.websocket.agents
        • parlai.chat_service.services.websocket.sockets
        • parlai.chat_service.services.websocket.websocket_manager
    • Utilities
      • parlai.chat_service.utils.config
      • parlai.chat_service.utils.image
      • parlai.chat_service.utils.logging
      • parlai.chat_service.utils.misc
      • parlai.chat_service.utils.server
      • parlai.chat_service.utils.timeout
  • parlai.core
    • parlai.core.agents
    • parlai.core.build_data
    • parlai.core.dict
    • parlai.core.loader
    • parlai.core.message
      • text
      • id
      • labels
      • eval_labels
      • label_candidates
      • text_candidates
      • episode_done
      • reward
      • image
      • extended fields
    • parlai.core.metrics
    • parlai.core.opt
    • parlai.core.params
    • parlai.core.script
    • parlai.core.teachers
    • parlai.core.torch_agent
      • Torch Agent
      • Torch Generator Agent
      • Torch Ranker Agent
      • Torch Classifier Agent
      • Torch Image Agent
    • parlai.core.worlds
  • parlai.utils
    • parlai.utils.bpe
    • parlai.utils.conversations
    • parlai.utils.data
    • parlai.utils.distributed
    • parlai.utils.fp16
    • parlai.utils.logging
    • parlai.utils.misc
    • parlai.utils.pickle
    • parlai.utils.safety
    • parlai.utils.strings
    • parlai.utils.testing
    • parlai.utils.torch
    • parlai.utils.typing
    • parlai.utils.world_logging
ParlAI
  • Docs »
  • parlai.core

parlai.core¶

This contains the full, comprehensive docstrings of all of parlai.core, which powers the vast majority of ParlAI.

  • parlai.core.agents
  • parlai.core.build_data
  • parlai.core.dict
  • parlai.core.loader
  • parlai.core.message
  • parlai.core.metrics
  • parlai.core.opt
  • parlai.core.params
  • parlai.core.script
  • parlai.core.teachers
  • parlai.core.torch_agent
  • parlai.core.worlds
Next Previous

© Copyright 2020, Facebook AI Research

Built with Sphinx using a theme provided by Read the Docs.