API Documentation¶

API documentation for the main Pimlico codebase, excluding the built-in Pimlico module types.

pimlico
- cli
  - browser
    - tools
      - corpus
      - files
      - formatter
    - tool
  - data_editor
    - pimlico.cli.data_editor.run module
  - debug
    - stepper
  - shell
    - base
    - commands
    - runner
  - check
  - clean
  - fixlength
  - jupyter
  - loaddump
  - locations
  - main
  - newmodule
  - pimarc
  - pyshell
  - recover
  - reset
  - run
  - status
  - subcommands
  - testemail
  - util
- core
  - dependencies
    - base
    - core
    - java
    - licenses
    - python
    - versions
  - external
    - java
  - modules
    - map
      - benchmark
      - filter
      - multiproc
      - singleproc
      - threaded
    - base
    - execute
    - inputs
    - multistage
    - options
  - config
  - logs
  - paths
- datatypes
  - corpora
    - parse
      - trees
    - base
    - data_points
    - floats
    - grouped
    - ints
    - json
    - strings
    - table
    - tokenized
    - word_annotations
  - arrays
  - base
  - core
  - dictionary
  - embeddings
  - features
  - files
  - gensim
  - keras
  - plotting
  - results
  - sklearn
- test
  - pipeline
  - suite
- utils
  - docs
    - apiheaders
    - commandgen
    - examplegen
    - modulegen
    - rest
    - testgen
  - pimarc
    - index
    - reader
    - tar
    - tools
    - utils
    - writer
  - communicate
  - core
  - email
  - filesystem
  - format
  - jupyter
  - linguistic
  - logging
  - network
  - pipes
  - pos
  - probability
  - progress
  - strings
  - system
  - timeout
  - urwid
  - varint
  - web
- cfg