API documentation

• bugfinder
  • bugfinder.settings
    • DATASET_DIRS
    • FEATURES_FILE
    • LOGGER
    • LOGGER_CONFIG
    • NEO4J_DEFAULT_TIMEOUT
    • NEO4J_V3_CORES
    • NEO4J_V3_MEMORY
    • POOL_SIZE
    • ROOT_DIR
    • SUMMARY_FILE
  • bugfinder.models
    • ClassifierModel
      • ClassifierModel.execute()
      • ClassifierModel.init_model()
    • bugfinder.models.linear_classifier
      • LinearClassifierTraining
        • LinearClassifierTraining.init_model()
    • bugfinder.models.lstm_classifier
      • LSTMClassifierTraining
        • LSTMClassifierTraining.build_model()
        • LSTMClassifierTraining.init_model()
    • bugfinder.models.interproc_lstm
      • InterprocLSTMTraining
        • InterprocLSTMTraining.execute()
        • InterprocLSTMTraining.init_model()
        • InterprocLSTMTraining.process_features()
    • bugfinder.models.blstm_classifier
      • BLSTMClassifierModel
        • BLSTMClassifierModel.evaluate()
        • BLSTMClassifierModel.execute()
        • BLSTMClassifierModel.init_model()
      • BLSTMClassifierTraining
        • BLSTMClassifierTraining.init_model()
    • bugfinder.models.sequential
      • SequenceGenerator
      • SequentialModel
        • SequentialModel.execute()
        • SequentialModel.init_model()
    • bugfinder.models.dnn_classifier
      • DNNClassifierTraining
        • DNNClassifierTraining.init_model()
  • bugfinder.utils
    • bugfinder.utils.dirs
      • copy_dir()
    • bugfinder.utils.feature_selection
      • retrieve_original_columns_name()
      • selection_estimators()
    • bugfinder.utils.processing
      • is_operation_valid()
      • is_processing_stack_valid()
    • bugfinder.utils.rand
      • get_rand_string()
    • bugfinder.utils.containers
      • start_container()
      • stop_container_by_name()
      • wait_log_display()
    • bugfinder.utils.statistics
      • display_time()
      • divide()
      • get_time()
      • has_better_metrics()
    • bugfinder.utils.progressbar
      • BestBar
        • BestBar.b_age
        • BestBar.b_stats
        • BestBar.b_val
        • BestBar.best_age
        • BestBar.best_stats
        • BestBar.best_val
        • BestBar.next()
        • BestBar.suffix
      • MultiBar
        • MultiBar.done
        • MultiBar.jobs
        • MultiBar.jobz
        • MultiBar.next()
        • MultiBar.queue
        • MultiBar.refresh()
        • MultiBar.subscribe()
        • MultiBar.suffix
        • MultiBar.unsubscribe()
      • SlowBar
        • SlowBar.extend()
        • SlowBar.slow_eta
        • SlowBar.suffix
  • bugfinder.base
    • bugfinder.base.dataset
      • CodeWeaknessClassificationDataset
        • CodeWeaknessClassificationDataset.append_summary()
        • CodeWeaknessClassificationDataset.clear_queue()
        • CodeWeaknessClassificationDataset.get_classes()
        • CodeWeaknessClassificationDataset.get_features_info()
        • CodeWeaknessClassificationDataset.ignored_dirs
        • CodeWeaknessClassificationDataset.load_summary()
        • CodeWeaknessClassificationDataset.process()
        • CodeWeaknessClassificationDataset.queue_operation()
        • CodeWeaknessClassificationDataset.rebuild_index()
        • CodeWeaknessClassificationDataset.reset_summary()
        • CodeWeaknessClassificationDataset.save_summary()
      • DatasetQueueRetCode
        • DatasetQueueRetCode.EMPTY_QUEUE
        • DatasetQueueRetCode.INVALID_QUEUE
        • DatasetQueueRetCode.OK
        • DatasetQueueRetCode.OPERATION_FAIL
    • bugfinder.base.processing
      • AbstractProcessing
        • AbstractProcessing.execute()
      • ProcessingCategory
        • ProcessingCategory.EXTRACTION
        • ProcessingCategory.PROCESSING
        • ProcessingCategory.REDUCTION
        • ProcessingCategory.TRAINING
      • ProcessingDeprecation
      • bugfinder.base.processing.files
        • AbstractFileProcessing
          • AbstractFileProcessing.execute()
          • AbstractFileProcessing.match_file()
          • AbstractFileProcessing.process_file()
      • bugfinder.base.processing.containers
        • AbstractContainerProcessing
          • AbstractContainerProcessing.assign_ports()
          • AbstractContainerProcessing.command
          • AbstractContainerProcessing.configure_command()
          • AbstractContainerProcessing.configure_container()
          • AbstractContainerProcessing.configure_container_with_dict()
          • AbstractContainerProcessing.container
          • AbstractContainerProcessing.container_name
          • AbstractContainerProcessing.container_ports
          • AbstractContainerProcessing.detach
          • AbstractContainerProcessing.environment
          • AbstractContainerProcessing.execute()
          • AbstractContainerProcessing.image_name
          • AbstractContainerProcessing.machine_ports
          • AbstractContainerProcessing.send_commands()
          • AbstractContainerProcessing.start_retries
          • AbstractContainerProcessing.volumes
  • bugfinder.features
    • bugfinder.features.reduction
      • AbstractFeatureSelector
        • AbstractFeatureSelector.execute()
        • AbstractFeatureSelector.select_feature()
      • bugfinder.features.reduction.pca
        • FeatureSelector
          • FeatureSelector.select_feature()
      • bugfinder.features.reduction.recursive_feature_elimination
        • FeatureSelector
          • FeatureSelector.select_feature()
      • bugfinder.features.reduction.auto_encoder
        • FeatureSelector
          • FeatureSelector.select_feature()
          • FeatureSelector.train_encoder()
      • bugfinder.features.reduction.select_from_model
        • FeatureSelector
          • FeatureSelector.select_feature()
      • bugfinder.features.reduction.univariate_select
        • FeatureSelector
          • FeatureSelector.select_feature()
      • bugfinder.features.reduction.variance_threshold
        • FeatureSelector
          • FeatureSelector.select_feature()
      • bugfinder.features.reduction.sequential_feature_selector
        • FeatureSelector
          • FeatureSelector.select_feature()
    • bugfinder.features.extraction
      • FlowGraphFeatureExtractor
        • FlowGraphFeatureExtractor.extract_features()
        • FlowGraphFeatureExtractor.extract_features_worker()
        • FlowGraphFeatureExtractor.finalize_features()
        • FlowGraphFeatureExtractor.get_flowgraph_count()
        • FlowGraphFeatureExtractor.get_flowgraph_list_for_entrypoint()
        • FlowGraphFeatureExtractor.get_label_from_flowgraph()
        • FlowGraphFeatureExtractor.initialize_features()
        • FlowGraphFeatureExtractor.map_features()
        • FlowGraphFeatureExtractor.map_features_worker()
      • GraphFeatureExtractor
        • GraphFeatureExtractor.check_extraction_inputs()
        • GraphFeatureExtractor.configure_container()
        • GraphFeatureExtractor.execute()
        • GraphFeatureExtractor.extract_features()
        • GraphFeatureExtractor.feature_map_filepath
        • GraphFeatureExtractor.get_labels_from_feature_map()
        • GraphFeatureExtractor.map_features()
        • GraphFeatureExtractor.need_map_features
        • GraphFeatureExtractor.save_labels_to_feature_map()
        • GraphFeatureExtractor.send_commands()
        • GraphFeatureExtractor.write_extraction_outputs()
      • bugfinder.features.extraction.interproc
        • FeatureExtractor
          • FeatureExtractor.catlock
          • FeatureExtractor.cats
          • FeatureExtractor.check_extraction_inputs()
          • FeatureExtractor.configure_container()
          • FeatureExtractor.configure_container_with_dict()
          • FeatureExtractor.extract_features()
          • FeatureExtractor.extract_features_worker()
          • FeatureExtractor.get_flowgraph_list_for_entrypoint()
          • FeatureExtractor.send_commands()
          • FeatureExtractor.timeout
          • FeatureExtractor.write_extraction_outputs()
      • bugfinder.features.extraction.bag_of_words
        • bugfinder.features.extraction.bag_of_words.hops_n_flows
          • FeatureExtractor
            • FeatureExtractor.configure_container()
            • FeatureExtractor.execute()
            • FeatureExtractor.finalize_features()
            • FeatureExtractor.flows
            • FeatureExtractor.get_flowgraph_count()
            • FeatureExtractor.get_flowgraph_list_for_entrypoint()
            • FeatureExtractor.get_label_from_flowgraph()
            • FeatureExtractor.max_hops
            • FeatureExtractor.min_hops
        • bugfinder.features.extraction.bag_of_words.single_hop
          • bugfinder.features.extraction.bag_of_words.single_hop.raw
            • FeatureExtractor
              • FeatureExtractor.configure_container()
              • FeatureExtractor.get_flowgraph_count()
              • FeatureExtractor.get_flowgraph_list_for_entrypoint()
              • FeatureExtractor.get_label_from_flowgraph()
        • bugfinder.features.extraction.bag_of_words.any_hop
          • bugfinder.features.extraction.bag_of_words.any_hop.all_flows
            • FeatureExtractor
              • FeatureExtractor.configure_container()
              • FeatureExtractor.get_flowgraph_count()
              • FeatureExtractor.get_flowgraph_list_for_entrypoint()
              • FeatureExtractor.get_label_from_flowgraph()
          • bugfinder.features.extraction.bag_of_words.any_hop.single_flow
            • FeatureExtractor
              • FeatureExtractor.FLOWS
              • FeatureExtractor.configure_container()
              • FeatureExtractor.finalize_features()
              • FeatureExtractor.get_flowgraph_count()
              • FeatureExtractor.get_flowgraph_list_for_entrypoint()
              • FeatureExtractor.get_label_from_flowgraph()
      • bugfinder.features.extraction.word2vec
        • bugfinder.features.extraction.word2vec.embeddings
          • Word2VecEmbeddings
            • Word2VecEmbeddings.execute()
            • Word2VecEmbeddings.get_token_list()
            • Word2VecEmbeddings.save_dataframe()
            • Word2VecEmbeddings.vectorize()
        • bugfinder.features.extraction.word2vec.model
          • Word2VecModel
            • Word2VecModel.algorithm
            • Word2VecModel.execute()
            • Word2VecModel.get_token_list()
            • Word2VecModel.min_count
            • Word2VecModel.seed
            • Word2VecModel.tokens
            • Word2VecModel.window_dim
            • Word2VecModel.word_dim
            • Word2VecModel.workers
      • bugfinder.features.extraction.node2vec
        • bugfinder.features.extraction.node2vec.embeddings
          • Node2VecEmbeddings
            • Node2VecEmbeddings.embedding_length
            • Node2VecEmbeddings.execute()
            • Node2VecEmbeddings.vector_length
        • bugfinder.features.extraction.node2vec.model
          • Node2VecModel
            • Node2VecModel.algorithm
            • Node2VecModel.execute()
            • Node2VecModel.min_count
            • Node2VecModel.num_walks
            • Node2VecModel.p
            • Node2VecModel.q
            • Node2VecModel.seed
            • Node2VecModel.tokens
            • Node2VecModel.vector_length
            • Node2VecModel.walk_length
            • Node2VecModel.window_dim
            • Node2VecModel.workers
        • bugfinder.features.extraction.node2vec.implementation
          • Node2VecImplementation
            • Node2VecImplementation.FIRST_TRAVEL_KEY
            • Node2VecImplementation.NEIGHBORS_KEY
            • Node2VecImplementation.NUM_WALKS_KEY
            • Node2VecImplementation.PROBABILITIES_KEY
            • Node2VecImplementation.P_KEY
            • Node2VecImplementation.Q_KEY
            • Node2VecImplementation.WALK_LENGTH_KEY
            • Node2VecImplementation.WEIGHT_KEY
            • Node2VecImplementation.fit()
  • bugfinder.processing
    • AbstractCppFileProcessing
      • AbstractCppFileProcessing.match_file()
      • AbstractCppFileProcessing.process_file()
    • bugfinder.processing.interproc
      • InterprocMerger
        • InterprocMerger.interproc_cmds_post
        • InterprocMerger.interproc_cmds_pre
        • InterprocMerger.interproc_cmds_tc
      • InterprocProcessing
        • InterprocProcessing.assign_ports()
        • InterprocProcessing.configure_command()
        • InterprocProcessing.configure_container()
        • InterprocProcessing.configure_container_with_dict()
        • InterprocProcessing.interproc_cmds_post
        • InterprocProcessing.interproc_cmds_pre
        • InterprocProcessing.interproc_cmds_tc
        • InterprocProcessing.log_input
        • InterprocProcessing.log_output
        • InterprocProcessing.send_commands()
      • interproc_worker()
    • bugfinder.processing.sink_tagging
      • SinkTaggingProcessing
        • SinkTaggingProcessing.assign_ports()
        • SinkTaggingProcessing.configure_command()
        • SinkTaggingProcessing.configure_container()
        • SinkTaggingProcessing.configure_container_with_dict()
        • SinkTaggingProcessing.log_input
        • SinkTaggingProcessing.log_output
        • SinkTaggingProcessing.send_commands()
        • SinkTaggingProcessing.sinksfile
      • sinktagging_worker()
    • bugfinder.processing.tokenizers
      • AbstractTokenizer
        • AbstractTokenizer.execute()
      • bugfinder.processing.tokenizers.replace_functions
        • ReplaceFunctions
          • ReplaceFunctions.execute()
          • ReplaceFunctions.process_file()
      • bugfinder.processing.tokenizers.replace_variables
        • ReplaceVariables
          • ReplaceVariables.execute()
          • ReplaceVariables.process_file()
      • bugfinder.processing.tokenizers.tokenize_code
        • TokenizeCode
          • TokenizeCode.execute()
          • TokenizeCode.process_file()
          • TokenizeCode.to_regex()
    • bugfinder.processing.cleaning
      • AbstractFileRemover
        • AbstractFileRemover.match_file()
        • AbstractFileRemover.process_file()
      • bugfinder.processing.cleaning.replace_litterals
        • ReplaceLitterals
          • ReplaceLitterals.execute()
          • ReplaceLitterals.process_file()
          • ReplaceLitterals.replacements
      • bugfinder.processing.cleaning.remove_cpp_files
        • RemoveCppFiles
          • RemoveCppFiles.execute()
          • RemoveCppFiles.match_file()
      • bugfinder.processing.cleaning.remove_main_function
        • RemoveMainFunction
          • RemoveMainFunction.execute()
          • RemoveMainFunction.main_fn_entry
          • RemoveMainFunction.main_fn_exit
          • RemoveMainFunction.process_file()
      • bugfinder.processing.cleaning.remove_interproc_files
        • RemoveInterprocFiles
          • RemoveInterprocFiles.execute()
          • RemoveInterprocFiles.match_file()
      • bugfinder.processing.cleaning.remove_comments
        • RemoveComments
          • RemoveComments.execute()
          • RemoveComments.process_file()
    • bugfinder.processing.neo4j
      • Neo4J3Processing
        • Neo4J3Processing.configure_container()
        • Neo4J3Processing.environment
        • Neo4J3Processing.fix_data_folder_rights()
        • Neo4J3Processing.neo4j_db
        • Neo4J3Processing.send_commands()
        • Neo4J3Processing.start_string
      • bugfinder.processing.neo4j.annot
        • Neo4JAnnotations
          • Neo4JAnnotations.COMMANDS
          • Neo4JAnnotations.configure_container()
          • Neo4JAnnotations.send_commands()
      • bugfinder.processing.neo4j.importer
        • Neo4J3Importer
          • Neo4J3Importer.configure_container()
          • Neo4J3Importer.db_name
          • Neo4J3Importer.import_dir
          • Neo4J3Importer.send_commands()
      • bugfinder.processing.neo4j.converter
        • Neo4J2Converter
          • Neo4J2Converter.START_STRING
          • Neo4J2Converter.configure_container()
          • Neo4J2Converter.send_commands()
        • Neo4J3Converter
          • Neo4J3Converter.configure_container()
          • Neo4J3Converter.send_commands()
    • bugfinder.processing.dataset
      • bugfinder.processing.dataset.inverse
        • InverseDataset
          • InverseDataset.execute()
      • bugfinder.processing.dataset.copy
        • CopyDataset
          • CopyDataset.execute()
      • bugfinder.processing.dataset.fix_rights
        • RightFixer
          • RightFixer.configure_command()
          • RightFixer.configure_container()
          • RightFixer.send_commands()
      • bugfinder.processing.dataset.extract
        • ExtractSampleDataset
          • ExtractSampleDataset.execute()
    • bugfinder.processing.joern
      • AbstractJoernProcessing
        • AbstractJoernProcessing.configure_container()
        • AbstractJoernProcessing.send_commands()
      • bugfinder.processing.joern.v031
        • JoernProcessing
          • JoernProcessing.configure_container()
          • JoernProcessing.send_commands()
      • bugfinder.processing.joern.v040
        • JoernProcessing
          • JoernProcessing.configure_container()
          • JoernProcessing.send_commands()
    • bugfinder.processing.ast
      • AbstractASTMarkup
        • AbstractASTMarkup.SET_AST_MARKUP_CMD
        • AbstractASTMarkup.build_ast_markup()
        • AbstractASTMarkup.get_ast_information()
        • AbstractASTMarkup.send_commands()
      • bugfinder.processing.ast.v03
        • Neo4JASTMarkup
          • Neo4JASTMarkup.build_ast_markup()
          • Neo4JASTMarkup.configure_container()
          • Neo4JASTMarkup.get_ast_information()
      • bugfinder.processing.ast.v02
        • Neo4JASTMarkup
          • Neo4JASTMarkup.build_ast_markup()
          • Neo4JASTMarkup.configure_container()
          • Neo4JASTMarkup.get_ast_information()
      • bugfinder.processing.ast.v01
        • Neo4JASTMarkup
          • Neo4JASTMarkup.build_ast_markup()
          • Neo4JASTMarkup.configure_container()
          • Neo4JASTMarkup.get_ast_information()