Skip to content

Commit

Permalink
First cut at config cleanup (#1411)
Browse files Browse the repository at this point in the history
* Firsst cut at config cleanup

* Reorder top nav

* Add query prompts to tuning page

* Remove dynamic notebook from nav

* Add more thorough yml config descriptions in docs

* Further clean out the config

* Semver

* Add new blog post

* Emphasize yaml

* Clarify output

* Fix unit test

* Fix bullet nesting
  • Loading branch information
natoverse authored Nov 15, 2024
1 parent 425dbc6 commit 9b4f24e
Show file tree
Hide file tree
Showing 23 changed files with 377 additions and 658 deletions.
4 changes: 4 additions & 0 deletions .semversioner/next-release/patch-20241115203715659970.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Config and docs updates."
}
7 changes: 7 additions & 0 deletions docs/blog_posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,11 @@

By Julian Whiting, Senior Machine Learning Engineer; Zachary Hills , Senior Software Engineer; [Alonso Guevara Fernández](https://www.microsoft.com/en-us/research/people/alonsog/), Sr. Software Engineer; [Ha Trinh](https://www.microsoft.com/en-us/research/people/trinhha/), Senior Data Scientist; Adam Bradley , Managing Partner, Strategic Research; [Jonathan Larson](https://www.microsoft.com/en-us/research/people/jolarso/), Senior Principal Data Architect</h6>

- [:octicons-arrow-right-24: __GraphRAG: Improving global search via dynamic community selection__](https://www.microsoft.com/en-us/research/blog/graphrag-improving-global-search-via-dynamic-community-selection/)

---
<h6>Published November 15, 2024

By Bryan Li, Research Intern; [Ha Trinh](https://www.microsoft.com/en-us/research/people/trinhha/), Senior Data Scientist; [Darren Edge](https://www.microsoft.com/en-us/research/people/daedge/), Senior Director; [Jonathan Larson](https://www.microsoft.com/en-us/research/people/jolarso/), Senior Principal Data Architect</h6>

</div>
162 changes: 0 additions & 162 deletions docs/config/custom.md

This file was deleted.

6 changes: 1 addition & 5 deletions docs/config/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,5 @@ The GraphRAG system is highly configurable. This page provides an overview of th
The default configuration mode is the simplest way to get started with the GraphRAG system. It is designed to work out-of-the-box with minimal configuration. The primary configuration sections for the Indexing Engine pipelines are described below. The main ways to set up GraphRAG in Default Configuration mode are via:

- [Init command](init.md) (recommended)
- [Using YAML for deeper control](yaml.md)
- [Purely using environment variables](env_vars.md)
- [Using JSON or YAML for deeper control](json_yaml.md)

## Custom Configuration Mode

Custom configuration mode is an advanced use-case. Most users will want to use the Default Configuration instead. The primary configuration sections for Indexing Engine pipelines are described below. Details about how to use custom configuration are available in the [Custom Configuration Mode](custom.md) documentation.
167 changes: 0 additions & 167 deletions docs/config/template.md

This file was deleted.

Loading

0 comments on commit 9b4f24e

Please sign in to comment.