Skip to content

API for a system recommendation explained using generative AI.

License

Notifications You must be signed in to change notification settings

fer-aguirre/explained-recommendations

Repository files navigation

Explained Recommendations 📑

A repository for building a system recommendation explained using generative AI for prompt engineering, text embeddings and vector search. This model will be deployed with Steamship packages and applied to Writing Atlas content.

Created by: Fer Aguirre


Directory Structure

|- .gitignore              # Customized .gitignore for python projects
|- LICENSE                 # Project's license
|- README.md               # Top-level README for this project
|
|- assets                  # Resources for the project
|
|- data                    # Categorized data files                      
|  |- processed            # Cleaned data
|  |- raw                  # Original data
|
|- docs                    # Explanatory materials
|  |- references           # Papers, manuals, articles, etc.
|  |- data-dictionary.md   # Information about the data
|
|- notebooks               # Jupyter notebooks
|  |- 0.0-process.ipynb    # Data processing (fixing column types, data cleansing, etc.)
|  |- 1.0-analyze.ipynb    # Exploratory data analysis
|  |- 2.0-visualize.ipynb  # Data visualization methods
|
|- outputs                 # Exports generated by notebooks
|  |- tables               # Generated pivot tables to analyze data
|  |- figures              # Generated graphics, maps, etc. to be used in reporting
| 
|- project                 # Python package
|  |- __init__.py
|  |- data                 # Functions to manipulate data
|  |  |- load.py           # Module to load data
|  |  |- process.py        # Module to process data
|  |  |- analyze.py        # Module to analyze data
|  |  |- export.py         # Module to save exports
|  |  |- __init__.py 
|  |  
|  |- utils                # Functions to make common patterns shorter and easier
|     |- paths.py          # Module to generate relative paths
|     |- __init__.py
|
|- setup.py                # Import project as a python module
|
|- Pipfile                 # Project dependencies

License

This project is released under MIT License.


This repository was generated with cookiecutter.

About

API for a system recommendation explained using generative AI.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published