Private Evolution Logo

Contents:

  • Getting Started
    • What is Private Evolution?
      • Key Features
      • What This Library Provides
      • Citations
    • Installation
      • PIP
        • The Main Package
        • Image Generation
        • Text Generation
        • Editable Mode
      • Faiss
    • Examples
      • Images
      • Text
    • Using Your Own Data/APIs
      • Data
      • APIs
    • Details of the Library
      • Overview
        • The Private Evolution Algorithm
        • Core Design Principles of This Library
        • Core Components of This Library
      • Data
        • Available Datasets
        • Using Your Own Datasets
      • Population
        • Available Populations
      • APIs
        • Available APIs
        • Adding Your Own APIs
      • Histograms
        • Available Histograms
      • DP
        • Available Differential Privacy Mechanisms
      • Embeddings
        • Available Embeddings
      • Callbacks and Loggers
        • Available Callbacks
        • Available Loggers
      • Runner
  • API Reference
    • pe
      • pe package
        • Subpackages
          • pe.api package
            • API
              • API.random_api()
              • API.variation_api()
            • Avatar
              • Avatar.__init__()
              • Avatar._get_params_from_avatar()
              • Avatar._get_random_image()
              • Avatar._get_variation_image()
              • Avatar._svg_to_numpy()
              • Avatar.random_api()
              • Avatar.variation_api()
            • DrawText
              • DrawText.__init__()
              • DrawText._create_image()
              • DrawText._get_random_image()
              • DrawText._get_variation_image()
              • DrawText.random_api()
              • DrawText.variation_api()
            • ImprovedDiffusion
              • ImprovedDiffusion.__init__()
              • ImprovedDiffusion.random_api()
              • ImprovedDiffusion.variation_api()
            • ImprovedDiffusion270M
              • ImprovedDiffusion270M.CHECKPOINT_URL
              • ImprovedDiffusion270M.__init__()
            • LLMAugPE
              • LLMAugPE.__init__()
              • LLMAugPE._blank_sample()
              • LLMAugPE._construct_prompt()
              • LLMAugPE.random_api()
              • LLMAugPE.variation_api()
            • NearestImage
              • NearestImage.__init__()
              • NearestImage._build_nearest_neighbor_graph()
              • NearestImage.random_api()
              • NearestImage.variation_api()
            • StableDiffusion
              • StableDiffusion.__init__()
              • StableDiffusion.random_api()
              • StableDiffusion.variation_api()
            • Subpackages
              • pe.api.image package
                • Subpackages
                  • pe.api.image.improved_diffusion_lib package
                    • Submodules
                      • pe.api.image.improved_diffusion_lib.gaussian_diffusion module
                        • create_gaussian_diffusion()
                      • pe.api.image.improved_diffusion_lib.unet module
                        • create_model()
                • Submodules
                  • pe.api.image.avatar_api module
                    • Avatar
                      • Avatar.__init__()
                      • Avatar._get_params_from_avatar()
                      • Avatar._get_random_image()
                      • Avatar._get_variation_image()
                      • Avatar._svg_to_numpy()
                      • Avatar.random_api()
                      • Avatar.variation_api()
                  • pe.api.image.draw_text_api module
                    • DrawText
                      • DrawText.__init__()
                      • DrawText._create_image()
                      • DrawText._get_random_image()
                      • DrawText._get_variation_image()
                      • DrawText.random_api()
                      • DrawText.variation_api()
                  • pe.api.image.improved_diffusion_api module
                    • ImprovedDiffusion
                      • ImprovedDiffusion.__init__()
                      • ImprovedDiffusion.random_api()
                      • ImprovedDiffusion.variation_api()
                    • ImprovedDiffusion270M
                      • ImprovedDiffusion270M.CHECKPOINT_URL
                      • ImprovedDiffusion270M.__init__()
                    • Sampler
                      • Sampler.forward()
                    • sample()
                  • pe.api.image.nearest_image_api module
                    • NearestImage
                      • NearestImage.__init__()
                      • NearestImage._build_nearest_neighbor_graph()
                      • NearestImage.random_api()
                      • NearestImage.variation_api()
                  • pe.api.image.stable_diffusion_api module
                    • StableDiffusion
                      • StableDiffusion.__init__()
                      • StableDiffusion.random_api()
                      • StableDiffusion.variation_api()
              • pe.api.text package
                • Submodules
                  • pe.api.text.llm_augpe_api module
                    • LLMAugPE
                      • LLMAugPE.__init__()
                      • LLMAugPE._blank_sample()
                      • LLMAugPE._construct_prompt()
                      • LLMAugPE.random_api()
                      • LLMAugPE.variation_api()
            • Submodules
              • pe.api.api module
                • API
                  • API.random_api()
                  • API.variation_api()
              • pe.api.util module
                • ConstantList
          • pe.callback package
            • Callback
              • Callback.__call__()
            • ComputeFID
              • ComputeFID.__call__()
              • ComputeFID.__init__()
            • ComputePrecisionRecall
              • ComputePrecisionRecall.__call__()
              • ComputePrecisionRecall.__init__()
            • DPImageBenchClassifyImages
              • DPImageBenchClassifyImages.__call__()
              • DPImageBenchClassifyImages.__init__()
              • DPImageBenchClassifyImages._get_data_loader()
              • DPImageBenchClassifyImages._get_images_and_label_from_data()
              • DPImageBenchClassifyImages._get_model()
              • DPImageBenchClassifyImages.evaluate()
            • SampleImages
              • SampleImages.__call__()
              • SampleImages.__init__()
            • SaveAllImages
              • SaveAllImages.__call__()
              • SaveAllImages.__init__()
              • SaveAllImages._save_image()
            • SaveCheckpoints
              • SaveCheckpoints.__call__()
              • SaveCheckpoints.__init__()
              • SaveCheckpoints._get_checkpoint_path()
            • SaveTextToCSV
              • SaveTextToCSV.__call__()
              • SaveTextToCSV.__init__()
              • SaveTextToCSV._get_csv_path()
            • Subpackages
              • pe.callback.common package
                • Submodules
                  • pe.callback.common.compute_fid module
                    • ComputeFID
                      • ComputeFID.__call__()
                      • ComputeFID.__init__()
                  • pe.callback.common.compute_precision_recall module
                    • ComputePrecisionRecall
                      • ComputePrecisionRecall.__call__()
                      • ComputePrecisionRecall.__init__()
                  • pe.callback.common.save_checkpoints module
                    • SaveCheckpoints
                      • SaveCheckpoints.__call__()
                      • SaveCheckpoints.__init__()
                      • SaveCheckpoints._get_checkpoint_path()
              • pe.callback.image package
                • Subpackages
                  • pe.callback.image.dpimagebench_lib package
                    • Submodules
                      • pe.callback.image.dpimagebench_lib.densenet module
                        • densenet()
                      • pe.callback.image.dpimagebench_lib.ema module
                        • ExponentialMovingAverage
                          • ExponentialMovingAverage.__init__()
                          • ExponentialMovingAverage.copy_to()
                          • ExponentialMovingAverage.load_state_dict()
                          • ExponentialMovingAverage.restore()
                          • ExponentialMovingAverage.state_dict()
                          • ExponentialMovingAverage.store()
                          • ExponentialMovingAverage.update()
                      • pe.callback.image.dpimagebench_lib.resnet module
                        • resnet()
                      • pe.callback.image.dpimagebench_lib.resnext module
                        • resnext()
                      • pe.callback.image.dpimagebench_lib.wrn module
                        • BasicBlock
                          • BasicBlock.forward()
                        • NetworkBlock
                          • NetworkBlock.forward()
                        • WideResNet
                          • WideResNet.forward()
                • Submodules
                  • pe.callback.image.dpimagebench_classify_images module
                    • DPImageBenchClassifyImages
                      • DPImageBenchClassifyImages.__call__()
                      • DPImageBenchClassifyImages.__init__()
                      • DPImageBenchClassifyImages._get_data_loader()
                      • DPImageBenchClassifyImages._get_images_and_label_from_data()
                      • DPImageBenchClassifyImages._get_model()
                      • DPImageBenchClassifyImages.evaluate()
                  • pe.callback.image.sample_images module
                    • SampleImages
                      • SampleImages.__call__()
                      • SampleImages.__init__()
                  • pe.callback.image.save_all_images module
                    • SaveAllImages
                      • SaveAllImages.__call__()
                      • SaveAllImages.__init__()
                      • SaveAllImages._save_image()
              • pe.callback.text package
                • Submodules
                  • pe.callback.text.save_text_to_csv module
                    • SaveTextToCSV
                      • SaveTextToCSV.__call__()
                      • SaveTextToCSV.__init__()
                      • SaveTextToCSV._get_csv_path()
            • Submodules
              • pe.callback.callback module
                • Callback
                  • Callback.__call__()
          • pe.constant package
            • Submodules
              • pe.constant.data module
                • CLEAN_HISTOGRAM_COLUMN_NAME
                • CLIENT_ID_COLUMN_NAME
                • DP_HISTOGRAM_COLUMN_NAME
                • EMBEDDING_COLUMN_NAME
                • FROM_LAST_FLAG_COLUMN_NAME
                • HISTOGRAM_NEAREST_NEIGHBORS_VOTING_IDS_COLUMN_NAME
                • IMAGE_DATA_COLUMN_NAME
                • IMAGE_MODEL_LABEL_COLUMN_NAME
                • IMAGE_PROMPT_COLUMN_NAME
                • LABEL_ID_COLUMN_NAME
                • LLM_PARAMETERS_COLUMN_NAME
                • LLM_REQUEST_MESSAGES_COLUMN_NAME
                • LOOKAHEAD_EMBEDDING_COLUMN_NAME
                • PARENT_SYN_DATA_INDEX_COLUMN_NAME
                • POST_PROCESSED_DP_HISTOGRAM_COLUMN_NAME
                • TEXT_DATA_COLUMN_NAME
                • VARIATION_API_FOLD_ID_COLUMN_NAME
          • pe.data package
            • Camelyon17
              • Camelyon17.__init__()
            • Cat
              • Cat.URL
              • Cat.__init__()
              • Cat._download()
              • Cat._read_data()
            • CelebA
              • CelebA.__init__()
            • Cifar10
              • Cifar10.__init__()
            • Data
              • Data.__init__()
              • Data.concat()
              • Data.filter()
              • Data.filter_label_id()
              • Data.load_checkpoint()
              • Data.merge()
              • Data.random_split()
              • Data.random_truncate()
              • Data.reset_index()
              • Data.save_checkpoint()
              • Data.set_label_id()
              • Data.split_by_client()
              • Data.split_by_index()
              • Data.truncate()
            • DigiFace1M
              • DigiFace1M.__init__()
              • DigiFace1M._read_and_process_image()
            • MNIST
              • MNIST.__init__()
            • OpenReview
              • OpenReview.DOWNLOAD_INFO_DICT
              • OpenReview.__init__()
              • OpenReview._download()
            • PubMed
              • PubMed.DOWNLOAD_INFO_DICT
              • PubMed.__init__()
              • PubMed._download()
            • TextCSV
              • TextCSV.__init__()
            • Yelp
              • Yelp.DOWNLOAD_INFO_DICT
              • Yelp.__init__()
              • Yelp._download()
            • load_image_folder()
            • Subpackages
              • pe.data.image package
                • Submodules
                  • pe.data.image.camelyon17 module
                    • Camelyon17
                      • Camelyon17.__init__()
                  • pe.data.image.cat module
                    • Cat
                      • Cat.URL
                      • Cat.__init__()
                      • Cat._download()
                      • Cat._read_data()
                  • pe.data.image.celeba module
                    • CelebA
                      • CelebA.__init__()
                    • target_transform
                  • pe.data.image.cifar10 module
                    • Cifar10
                      • Cifar10.__init__()
                  • pe.data.image.digiface1m module
                    • DigiFace1M
                      • DigiFace1M.__init__()
                      • DigiFace1M._read_and_process_image()
                  • pe.data.image.image module
                    • ImageDataset
                    • _list_image_files_recursively()
                    • load_image_folder()
                  • pe.data.image.mnist module
                    • MNIST
                      • MNIST.__init__()
              • pe.data.text package
                • Submodules
                  • pe.data.text.openreview module
                    • DownloadInfo
                    • OpenReview
                      • OpenReview.DOWNLOAD_INFO_DICT
                      • OpenReview.__init__()
                      • OpenReview._download()
                  • pe.data.text.pubmed module
                    • DownloadInfo
                    • PubMed
                      • PubMed.DOWNLOAD_INFO_DICT
                      • PubMed.__init__()
                      • PubMed._download()
                  • pe.data.text.text_csv module
                    • TextCSV
                      • TextCSV.__init__()
                  • pe.data.text.yelp module
                    • DownloadInfo
                    • Yelp
                      • Yelp.DOWNLOAD_INFO_DICT
                      • Yelp.__init__()
                      • Yelp._download()
            • Submodules
              • pe.data.data module
                • Data
                  • Data.__init__()
                  • Data.concat()
                  • Data.filter()
                  • Data.filter_label_id()
                  • Data.load_checkpoint()
                  • Data.merge()
                  • Data.random_split()
                  • Data.random_truncate()
                  • Data.reset_index()
                  • Data.save_checkpoint()
                  • Data.set_label_id()
                  • Data.split_by_client()
                  • Data.split_by_index()
                  • Data.truncate()
          • pe.dp package
            • DP
              • DP.add_noise()
              • DP.set_epsilon_and_delta()
            • Gaussian
              • Gaussian.add_noise()
              • Gaussian.set_epsilon_and_delta()
            • Submodules
              • pe.dp.dp module
                • DP
                  • DP.add_noise()
                  • DP.set_epsilon_and_delta()
              • pe.dp.gaussian module
                • Gaussian
                  • Gaussian.add_noise()
                  • Gaussian.set_epsilon_and_delta()
                • compute_epsilon()
                • delta_Gaussian()
                • eps_Gaussian()
                • get_noise_multiplier()
          • pe.embedding package
            • Embedding
              • Embedding.column_name
              • Embedding.compute_embedding()
              • Embedding.filter_uncomputed_rows()
              • Embedding.merge_computed_rows()
            • FLDInception
              • FLDInception.__init__()
              • FLDInception.compute_embedding()
            • Inception
              • Inception.__init__()
              • Inception.compute_embedding()
            • SentenceTransformer
              • SentenceTransformer.__init__()
              • SentenceTransformer.column_name
              • SentenceTransformer.compute_embedding()
            • Subpackages
              • pe.embedding.image package
                • Submodules
                  • pe.embedding.image.fld_inception module
                    • FLDInception
                      • FLDInception.__init__()
                      • FLDInception.compute_embedding()
                    • to_uint8()
                  • pe.embedding.image.inception module
                    • Inception
                      • Inception.__init__()
                      • Inception.compute_embedding()
                    • to_uint8()
              • pe.embedding.text package
                • Submodules
                  • pe.embedding.text.sentence_transformer module
                    • SentenceTransformer
                      • SentenceTransformer.__init__()
                      • SentenceTransformer.column_name
                      • SentenceTransformer.compute_embedding()
            • Submodules
              • pe.embedding.embedding module
                • Embedding
                  • Embedding.column_name
                  • Embedding.compute_embedding()
                  • Embedding.filter_uncomputed_rows()
                  • Embedding.merge_computed_rows()
          • pe.histogram package
            • Histogram
              • Histogram.compute_histogram()
            • NearestNeighbors
              • NearestNeighbors.__init__()
              • NearestNeighbors._compute_lookahead_embedding()
              • NearestNeighbors._log_lookahead()
              • NearestNeighbors._log_voting_details()
              • NearestNeighbors.compute_histogram()
            • Subpackages
              • pe.histogram.nearest_neighbor_backend package
                • Submodules
                  • pe.histogram.nearest_neighbor_backend.auto module
                    • search()
                  • pe.histogram.nearest_neighbor_backend.faiss module
                    • search()
                  • pe.histogram.nearest_neighbor_backend.sklearn module
                    • search()
            • Submodules
              • pe.histogram.histogram module
                • Histogram
                  • Histogram.compute_histogram()
              • pe.histogram.nearest_neighbors module
                • NearestNeighbors
                  • NearestNeighbors.__init__()
                  • NearestNeighbors._compute_lookahead_embedding()
                  • NearestNeighbors._log_lookahead()
                  • NearestNeighbors._log_voting_details()
                  • NearestNeighbors.compute_histogram()
          • pe.llm package
            • AzureOpenAILLM
              • AzureOpenAILLM.__init__()
              • AzureOpenAILLM._get_environment_variable()
              • AzureOpenAILLM._get_response_for_one_request()
              • AzureOpenAILLM.generation_arg_map
              • AzureOpenAILLM.get_responses()
            • HuggingfaceLLM
              • HuggingfaceLLM.__init__()
              • HuggingfaceLLM._get_conv_template()
              • HuggingfaceLLM._get_prompt()
              • HuggingfaceLLM._get_responses()
              • HuggingfaceLLM.generation_arg_map
              • HuggingfaceLLM.get_responses()
            • LLM
              • LLM.generation_arg_map
              • LLM.get_generation_args()
              • LLM.get_responses()
            • OpenAILLM
              • OpenAILLM.__init__()
              • OpenAILLM._get_environment_variable()
              • OpenAILLM._get_response_for_one_request()
              • OpenAILLM.get_responses()
            • Request
            • Subpackages
              • pe.llm.huggingface package
                • Subpackages
                  • pe.llm.huggingface.register_fastchat package
                    • Submodules
                      • pe.llm.huggingface.register_fastchat.gpt2 module
                        • register()
                • Submodules
                  • pe.llm.huggingface.huggingface module
                    • HuggingfaceLLM
                      • HuggingfaceLLM.__init__()
                      • HuggingfaceLLM._get_conv_template()
                      • HuggingfaceLLM._get_prompt()
                      • HuggingfaceLLM._get_responses()
                      • HuggingfaceLLM.generation_arg_map
                      • HuggingfaceLLM.get_responses()
            • Submodules
              • pe.llm.azure_openai module
                • AzureOpenAILLM
                  • AzureOpenAILLM.__init__()
                  • AzureOpenAILLM._get_environment_variable()
                  • AzureOpenAILLM._get_response_for_one_request()
                  • AzureOpenAILLM.generation_arg_map
                  • AzureOpenAILLM.get_responses()
              • pe.llm.llm module
                • LLM
                  • LLM.generation_arg_map
                  • LLM.get_generation_args()
                  • LLM.get_responses()
              • pe.llm.openai module
                • OpenAILLM
                  • OpenAILLM.__init__()
                  • OpenAILLM._get_environment_variable()
                  • OpenAILLM._get_response_for_one_request()
                  • OpenAILLM.get_responses()
              • pe.llm.request module
                • Request
          • pe.logger package
            • CSVPrint
              • CSVPrint.__init__()
              • CSVPrint._clear_logs()
              • CSVPrint._flush()
              • CSVPrint._get_log_path()
              • CSVPrint._log_float()
              • CSVPrint.clean_up()
              • CSVPrint.log()
            • ImageFile
              • ImageFile.__init__()
              • ImageFile._get_image_path()
              • ImageFile._log_image()
              • ImageFile._log_image_list()
              • ImageFile.log()
            • LogPrint
              • LogPrint.__init__()
              • LogPrint.log()
            • Logger
              • Logger.clean_up()
              • Logger.log()
            • MatplotlibPDF
              • MatplotlibPDF.__init__()
              • MatplotlibPDF._get_pdf_path()
              • MatplotlibPDF.log()
            • Submodules
              • pe.logger.csv_print module
                • CSVPrint
                  • CSVPrint.__init__()
                  • CSVPrint._clear_logs()
                  • CSVPrint._flush()
                  • CSVPrint._get_log_path()
                  • CSVPrint._log_float()
                  • CSVPrint.clean_up()
                  • CSVPrint.log()
              • pe.logger.image_file module
                • ImageFile
                  • ImageFile.__init__()
                  • ImageFile._get_image_path()
                  • ImageFile._log_image()
                  • ImageFile._log_image_list()
                  • ImageFile.log()
              • pe.logger.log_print module
                • LogPrint
                  • LogPrint.__init__()
                  • LogPrint.log()
              • pe.logger.logger module
                • Logger
                  • Logger.clean_up()
                  • Logger.log()
              • pe.logger.matplotlib_pdf module
                • MatplotlibPDF
                  • MatplotlibPDF.__init__()
                  • MatplotlibPDF._get_pdf_path()
                  • MatplotlibPDF.log()
          • pe.logging package
            • execution_logger
            • setup_logging()
          • pe.metric_item package
            • FloatListMetricItem
            • FloatMetricItem
            • ImageListMetricItem
              • ImageListMetricItem.__init__()
              • ImageListMetricItem.num_images_per_row
            • ImageMetricItem
            • MatplotlibMetricItem
              • MatplotlibMetricItem.clean_up()
            • MetricItem
              • MetricItem.__init__()
              • MetricItem.clean_up()
              • MetricItem.name
              • MetricItem.value
            • metric_scope
          • pe.population package
            • PEPopulation
              • PEPopulation.__init__()
              • PEPopulation._post_process_histogram()
              • PEPopulation._select_data()
              • PEPopulation.initial()
              • PEPopulation.next()
            • Population
              • Population.initial()
              • Population.next()
            • Submodules
              • pe.population.pe_population module
                • PEPopulation
                  • PEPopulation.__init__()
                  • PEPopulation._post_process_histogram()
                  • PEPopulation._select_data()
                  • PEPopulation.initial()
                  • PEPopulation.next()
              • pe.population.population module
                • Population
                  • Population.initial()
                  • Population.next()
          • pe.runner package
            • PE
              • PE.__init__()
              • PE._clean_up_loggers()
              • PE._get_num_samples_per_label_id()
              • PE._log_metrics()
              • PE.evaluate()
              • PE.load_checkpoint()
              • PE.run()
            • Submodules
              • pe.runner.pe module
                • PE
                  • PE.__init__()
                  • PE._clean_up_loggers()
                  • PE._get_num_samples_per_label_id()
                  • PE._log_metrics()
                  • PE.evaluate()
                  • PE.load_checkpoint()
                  • PE.run()
          • pe.util package
            • Submodules
              • pe.util.download module
                • download()
Private Evolution
  • API Reference
  • pe
  • pe package
  • pe.constant package
  • View page source

pe.constant package

Submodules

  • pe.constant.data module
    • CLEAN_HISTOGRAM_COLUMN_NAME
    • CLIENT_ID_COLUMN_NAME
    • DP_HISTOGRAM_COLUMN_NAME
    • EMBEDDING_COLUMN_NAME
    • FROM_LAST_FLAG_COLUMN_NAME
    • HISTOGRAM_NEAREST_NEIGHBORS_VOTING_IDS_COLUMN_NAME
    • IMAGE_DATA_COLUMN_NAME
    • IMAGE_MODEL_LABEL_COLUMN_NAME
    • IMAGE_PROMPT_COLUMN_NAME
    • LABEL_ID_COLUMN_NAME
    • LLM_PARAMETERS_COLUMN_NAME
    • LLM_REQUEST_MESSAGES_COLUMN_NAME
    • LOOKAHEAD_EMBEDDING_COLUMN_NAME
    • PARENT_SYN_DATA_INDEX_COLUMN_NAME
    • POST_PROCESSED_DP_HISTOGRAM_COLUMN_NAME
    • TEXT_DATA_COLUMN_NAME
    • VARIATION_API_FOLD_ID_COLUMN_NAME
Previous Next

© Copyright 2024, Zinan Lin.

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