Getting Started

1. Setting up your environment: Ensure you have Python and pipinstalled on your system. Create a virtual environment and activate it for RiskNet. For a containerized environment, RiskNet provides a Docker image. Refer to our Docker User Guide for detailed instructions.

2. Installation:To install the RiskNet package, run the following command:pip install risknet.

3. Explore the Code: Dive into the RiskNet codebase by forking the repository from our Github Repo

4. Understanding Structure: RiskNet's architecture is designed for ease of use and extensibility:
/src/risknet: The core directory containing all the source code.
/config: Houses the conf.yaml file to assist with setup.
/data: An empty directory for storing the Freddie Mac dataset.
/jobs: Includes scripts like cloud_etl.py for cloud interactions.
/proc: Contains preprocessing modules for data preparation.
/sys: Setup system environment and logging mechanisms here.

Data Introduction and How to Access

Data Introduction:

Our model is based on Freddie Mac Single-Family Loan Dataset. As part of a larger effort to increase transparency, Freddie Mac is making available loan-level credit performance data on all mortgages that the company purchased or guaranteed from 1999 to 2023.

How to Access Data:

      2. Download the 2009_Q1 dataset and unzip it.
      3. Place the data in the src/data directory of your local RiskNet repository.

Common Questions and Concerns

Risknet FAQs:

What is Risknet?

Check out our index page to learn more about what Risknet is!

What do I need to run Risknet?

Risknet currently requires access to UCSD's DSMLP instance. Other than that, you need reliable internet to run this code.

For more information, check out Terin's Guide to "How to Set Up DSMLP".

I want to use Risknet in my project. How can I credit the developers?

Thank you for asking! Crediting the developers is not only ethical, but legally required thanks to plagiarism laws.

If you want to use this project for education purposes, please cite our code using the Github link as described on the MIT website (here)

Can I adapt Risknet for a for-profit goal?

At this time, we do not consent for our code to be copied for profit. If you are interested in using Risknet as source code for a for-profit project, please reach out to us through our Github Issues page.


Risknet Resources:

Setting up DSMLP for RiskNet

  • Terin's Risknet-specific Guide here: (link)
  • UCSD's General DSMLP Documentation here: (here)

Risknet Documentation

Riya and Emily's Risknet Documentation: (here)

GitHub Repository and Readme: (here)

Risknet Pip Package Questions

Risknet PyPi Page: (here)

Need Further Help?

If you encounter any issues or have questions, don't hesitate to reach out to us through our GitHub issues page.

Join the Development

Interested in contributing? We welcome pull requests and community contributions. Check out our contribution guidelines for more information.