opacus
Training PyTorch models with differential privacy
File Explorer
Download Latest Version (.zip)- bug-report.md
- config.yml
- documentation.md
- feature-request.md
- ci_cpu.yml
- ci_gpu.yml
- deploy.yml
- flake8_config.ini
- python-publish.yml
- test-deploy.yml
- test-installation.yml
- PULL_REQUEST_TEMPLATE.md
- helpers.py
- test_benchmark_layer.py
- test_layers.py
- test_utils.py
- __init__.py
- benchmark_layer.py
- check_threshold.py
- config.json
- generate_report.py
- layers.py
- README.md
- run_benchmarks.py
- utils.py
- epsilon-delta-dp.png
- faq.md
- introduction.md
- make_small_imagenet_N_classes.sh
- make_small_imagenet_sampled.sh
- __init__.py
- char-lstm-classification.py
- char-lstm_README.md
- cifar10.py
- dcgan.py
- fsdp_example.py
- fsdp_llama3.py
- imdb.py
- imdb_README.md
- mnist.py
- mnist_lightning.py
- mnist_README.md
- README.md
- tensor_parallelism_llama.py
- tensor_parallelism_toy.py
- vision_benchmark.py
- __init__.py
- compose.py
- domain.py
- prvs.py
- __init__.py
- gdp.py
- rdp.py
- __init__.py
- accountant.py
- gdp.py
- prv.py
- rdp.py
- registry.py
- utils.py
- __init__.py
- conv.py
- dp_multihead_attention.py
- dp_rnn.py
- embedding.py
- embedding_norm_sample.py
- functorch.py
- grad_sample_module.py
- grad_sample_module_fast_gradient_clipping.py
- grad_sample_module_fast_gradient_clipping_fsdp.py
- grad_sample_module_fast_gradient_clipping_tp.py
- group_norm.py
- gsm_base.py
- gsm_exp_weights.py
- gsm_no_op.py
- instance_norm.py
- layer_norm.py
- linear.py
- README.md
- rms_norm.py
- utils.py
- __init__.py
- dp_multihead_attention.py
- dp_rnn.py
- param_rename.py
- __init__.py
- adaclipoptimizer.py
- ddp_perlayeroptimizer.py
- ddpoptimizer.py
- ddpoptimizer_fast_gradient_clipping.py
- fsdpoptimizer_fast_gradient_clipping.py
- optimizer.py
- optimizer_fast_gradient_clipping.py
- perlayeroptimizer.py
- utils.py
- __init__.py
- grad_clip_scheduler.py
- noise_scheduler.py
- compute_dp_sgd_privacy.py
- __init__.py
- common.py
- dp_multihead_attention_test.py
- dp_rnn_test.py
- __init__.py
- common.py
- conv1d_test.py
- conv2d_test.py
- conv3d_test.py
- dp_multihead_attention_test.py
- dp_rnn_test.py
- embedding_bag_test.py
- embedding_norm_sample_test.py
- embedding_test.py
- group_norm_test.py
- instance_norm1d_test.py
- instance_norm2d_test.py
- instance_norm3d_test.py
- layer_norm_test.py
- linear_test.py
- rms_norm_test.py
- sequence_bias_test.py
- __init__.py
- grad_clip_scheduler_test.py
- noise_scheduler_test.py
- __init__.py
- batch_norm_test.py
- gru_test.py
- instance_norm_test.py
- lstm_test.py
- multihead_attention_test.py
- __init__.py
- accountants_test.py
- accounting_noise_multiplier_test.py
- batch_memory_manager_test.py
- ddp_hook_check.py
- distributed_poisson_test.py
- dpdataloader_test.py
- grad_sample_hooks_fast_gradient_clipping_test.py
- grad_sample_hooks_test.py
- grad_sample_module_fast_gradient_clipping_test.py
- grad_sample_module_test.py
- gradient_accumulation_test.py
- mixed_precision_test.py
- mixed_precision_utils.py
- module_validator_test.py
- multidevice_optimizer_test.py
- multigpu_adaptive_clipping_test.py
- multigpu_fsdpcheck.py
- multigpu_gradcheck_test.py
- multigpu_precision_test.py
- per_sample_gradients_utils_test.py
- poisson_test.py
- privacy_engine_test.py
- privacy_engine_validation_test.py
- prv_accountant.py
- randomness_test.py
- utils.py
- __init__.py
- adaptive_clipping_utils.py
- README.md
- __init__.py
- batch_memory_manager.py
- fast_gradient_clipping_utils.py
- fsdp_utils.py
- module_utils.py
- packed_sequences.py
- per_sample_gradients_utils.py
- tensor_utils.py
- uniform_sampler.py
- __init__.py
- batch_norm.py
- errors.py
- gru.py
- instance_norm.py
- lstm.py
- module_validator.py
- multihead_attention.py
- utils.py
- __init__.py
- data_loader.py
- distributed.py
- lightning.py
- privacy_engine.py
- README.md
- version.py
- __init__.py
- KFadaclipoptimizer.py
- KFddp_perlayeroptimizer.py
- KFddpoptimizer.py
- KFddpoptimizer_fast_gradient_clipping.py
- KFoptimizer.py
- KFoptimizer_fast_gradient_clipping.py
- KFperlayeroptimizer.py
- KFprivacy_engine.py
- ReadMe.md
- README.md
- install_via_pip.sh
- pytorch_install.ps1
- pytorch_install.sh
- BERT.png
- make_private.png
- optimizer.png
- building_image_classifier.ipynb
- building_lstm_name_classifier.ipynb
- building_text_classifier.ipynb
- ddp_tutorial.ipynb
- guide_to_grad_sampler.ipynb
- guide_to_module_validator.ipynb
- intro_to_advanced_features.ipynb
- non_wrapping_mode.ipynb
- README.md
- Footer.js
- Tutorial.js
- TutorialSidebar.js
- index.js
- index.js
- build_website.sh
- parse_sphinx.py
- parse_tutorials.py
- accounting.rst
- gdp.rst
- iaccountant.rst
- rdp.rst
- utils.rst
- dp_ddp_optimizer.rst
- dp_ddp_optimizer_fast_gradient_clipping.rst
- dp_ddp_per_layer_optimizer.rst
- dp_optimizer.rst
- dp_optimizer_fast_gradient_clipping.rst
- dp_per_layer_optimizer.rst
- optimizers.rst
- fast_gradient_clipping_utils.rst
- module_utils.rst
- packed_sequences.rst
- tensor_utils.rst
- uniform_sampler.rst
- utils.rst
- batch_memory_manager.rst
- compute_dp_sgd_privacy.rst
- conf.py
- data_loader.rst
- distributed.rst
- dp_multihead_attention.rst
- dp_rnn.rst
- grad_sample_module.rst
- grad_sample_module_fast_gradient_clipping.rst
- index.rst
- layers.rst
- noise_scheduler.rst
- privacy_engine.rst
- scripts.rst
- validator.rst
- make.bat
- Makefile
- alabaster.css
- basic.css
- code_block_buttons.css
- custom.css
- expanding_arrows.svg
- modular.svg
- opacus_favicon.svg
- opacus_logo.svg
- opacus_logo_vertical.svg
- oss_logo.png
- pytorch_logo.svg
- logo_data.json
- .nojekyll
- pygments.css
- package.json
- requirements.txt
- sidebars.json
- siteConfig.js
- tutorials.json
- .gitignore
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- conftest.py
- CONTRIBUTING.md
- dev_requirements.txt
- LICENSE
- MANIFEST.in
- Migration_Guide.md
- README.md
- requirements.txt
- setup.py
# Installation Guide
1. Get the code
git clone https://github.com/meta-pytorch/opacus
Downloads the entire project code from GitHub to your computer.
cd opacus
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install opacus
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install opacus
Installs the package published on PyPI directly β no need to clone the source.
pip install -e .
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)