modbot
  • Home Page
    • Installation
    • Environment variables
    • Training Model
    • Running
  • Installation
  • API reference
    • modbot.modbot_argparse
      • modbot_argparse()
    • modbot.connection
      • modbot.connection.base
        • modbot.connection.base.BaseSocketClientAsync
        • modbot.connection.base.StreamHandlerAsync
      • modbot.connection.irc_client
        • modbot.connection.irc_client.IrcSocketClientAsync
      • modbot.connection.pubsub_client
        • modbot.connection.pubsub_client.WebSocketClientAsync
    • modbot.environment
      • modbot.environment.get_model_path
        • get_model_path()
      • modbot.environment.BaseConfig
        • BaseConfig
      • modbot.environment.ProcessingConfig
        • ProcessingConfig
      • modbot.environment.RunConfig
        • RunConfig
    • modbot.moderation
      • modbot.moderation.Moderation
        • Moderation
      • modbot.moderation.Nuking
        • Nuking
      • modbot.moderation.Permitting
        • Permitting
    • modbot.preprocessing
      • modbot.preprocessing.check_msgs
        • check_msgs()
      • modbot.preprocessing.check_phrases
        • check_phrases()
      • modbot.preprocessing.check_probs
        • check_probs()
      • modbot.preprocessing.contains_link
        • contains_link()
      • modbot.preprocessing.correct_messages
        • correct_messages()
      • modbot.preprocessing.correct_msg
        • correct_msg()
      • modbot.preprocessing.filter_all_emotes
        • filter_all_emotes()
      • modbot.preprocessing.filter_emotes
        • filter_emotes()
      • modbot.preprocessing.filter_log
        • filter_log()
      • modbot.preprocessing.get_info_from_chatty
        • get_info_from_chatty()
      • modbot.preprocessing.join_words
        • join_words()
      • modbot.preprocessing.my_lemmatizer
        • my_lemmatizer()
      • modbot.preprocessing.my_tokenizer
        • my_tokenizer()
      • modbot.preprocessing.preproc_words
        • preproc_words()
      • modbot.preprocessing.read_data
        • read_data()
      • modbot.preprocessing.remove_stopwords
        • remove_stopwords()
      • modbot.preprocessing.segment_words
        • segment_words()
      • modbot.preprocessing.separate_links
        • separate_links()
      • modbot.preprocessing.separate_tocheck
        • separate_tocheck()
      • modbot.preprocessing.write_data
        • write_data()
      • modbot.preprocessing.LogCleaning
        • LogCleaning
      • modbot.preprocessing.MsgMemory
        • MsgMemory
    • modbot.training
      • modbot.training.get_model_class
        • get_model_class()
      • modbot.training.training_argparse
        • training_argparse()
    • modbot.utilities
      • modbot.utilities.logging
        • modbot.utilities.logging.get_logger
        • modbot.utilities.logging.ColoredFormatter
        • modbot.utilities.logging.CustomLogger
        • modbot.utilities.logging.Logging
        • modbot.utilities.logging.PrivateLogger
      • modbot.utilities.loss_metrics
        • modbot.utilities.loss_metrics.gaussian_kernel
        • modbot.utilities.loss_metrics.max_mean_discrepancy
      • modbot.utilities.utilities
        • modbot.utilities.utilities.curvature
        • modbot.utilities.utilities.delete_usernames
        • modbot.utilities.utilities.get_badges
        • modbot.utilities.utilities.get_line_type
        • modbot.utilities.utilities.get_message
        • modbot.utilities.utilities.get_msg_id
        • modbot.utilities.utilities.get_role
        • modbot.utilities.utilities.get_user
        • modbot.utilities.utilities.get_user_type_chatty
        • modbot.utilities.utilities.is_line_type
        • modbot.utilities.utilities.is_user_type_chatty
        • modbot.utilities.utilities.is_user_type_irc
        • modbot.utilities.utilities.none_or_float
        • modbot.utilities.utilities.none_or_int
        • modbot.utilities.utilities.none_or_str
        • modbot.utilities.utilities.parse_radiation
        • modbot.utilities.utilities.parse_time
        • modbot.utilities.utilities.prune_chars
        • modbot.utilities.utilities.remove_reps
        • modbot.utilities.utilities.remove_special_chars
        • modbot.utilities.utilities.simple_chars_equal
        • modbot.utilities.utilities.UserInfo
    • modbot.version
  • Command Line Usage
    • Training Command
      • Named Arguments
modbot
  • Clone repo (recommended for developers)
  • Edit on GitHub

Clone repo (recommended for developers)

  1. from home dir, git clone git@github.com:bnb32/modbot.git

  2. Create modbot environment and install package
    1. Create a conda env: conda create -n modbot

    2. Run the command: conda activate modbot

    3. cd into the repo cloned in 1.

    4. prior to running pip below, make sure the branch is correct (install from main!)

    5. Install modbot and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)

    6. To train on a GPU run pip install tensorflow-gpu and conda install -c conda-forge cudnn

    7. If using a BERT model download a preprocessing model and encoder and put in data/bert_preprocess and data/bert_encoder, respectively. Example downloads: https://tfhub.dev/tensorflow/bert_en_uncased_preprocess/3 and https://tfhub.dev/tensorflow/bert_en_uncased_L-12_H-768_A-12/4

Previous Next

© Copyright 2022, Brandon Benton.

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