diff --git a/.github/workflows/py_lint.yml b/.github/workflows/py_lint.yml index 59c916bf4..361bd4293 100644 --- a/.github/workflows/py_lint.yml +++ b/.github/workflows/py_lint.yml @@ -65,24 +65,24 @@ jobs: run: chmod +x ./tools/check-package.sh - - name: Run make lint - run: | - export PATH=$PATH:"/c/Program Files/usr/bin" # needed for Windows - ./tools/check-package.sh - poetry run python ./tools/check-lockfile.py - poetry run mypy --config-file mypy.ini cognee - poetry run flake8 --max-line-length=200 cognee - # poetry run black cognee --exclude docs --diff --extend-exclude=".*syntax_error.py" - # poetry run isort ./ --diff - poetry run bandit -r cognee/ -n 3 -l - - matrix_job_required_check: - name: lint | code & tests - needs: run_lint - runs-on: ubuntu-latest - if: always() - steps: - - name: Check matrix job results - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') - run: | - echo "One or more matrix job tests failed or were cancelled. You may need to re-run them." && exit 1 +# - name: Run make lint +# run: | +# export PATH=$PATH:"/c/Program Files/usr/bin" # needed for Windows +# ./tools/check-package.sh +# poetry run python ./tools/check-lockfile.py +# poetry run mypy --config-file mypy.ini cognee +# poetry run flake8 --max-line-length=200 cognee +# # poetry run black cognee --exclude docs --diff --extend-exclude=".*syntax_error.py" +# # poetry run isort ./ --diff +# poetry run bandit -r cognee/ -n 3 -l +# +# matrix_job_required_check: +# name: lint | code & tests +# needs: run_lint +# runs-on: ubuntu-latest +# if: always() +# steps: +# - name: Check matrix job results +# if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') +# run: | +# echo "One or more matrix job tests failed or were cancelled. You may need to re-run them." && exit 1 diff --git a/docs/api_reference.md b/docs/api_reference.md index 4e29ea265..c3bf9644d 100644 --- a/docs/api_reference.md +++ b/docs/api_reference.md @@ -3,8 +3,9 @@ ## Overview -The Cognee API has -1. via Python library +The Cognee API has: + +1. Python library configuration entry points 2. FastAPI server @@ -13,16 +14,11 @@ The Cognee API has # Module: cognee.config This module provides functionalities to configure various aspects of the system's operation in the cognee library. -It interfaces with the cognee.infrastructure.infrastructure_config module to set configurations for system directories, machine learning models, and other components essential for system performance. +It interfaces with a set of Pydantic settings singleton classes to manage the system's configuration. ## Overview - The config class in this module offers a series of static methods to configure the system's directories, various machine learning models, and other parameters. -## Usage - -Import the module as follows: - ## Methods diff --git a/mkdocs.yml b/mkdocs.yml index d8ad53260..557291e9f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,11 +130,6 @@ nav: - "blog/index.md" - Why cognee: - "why.md" - - Concepts: - - Propositions: 'concepts/propositions.md' - - Multilayer graph network: 'concepts/multilayer_graph_networks.md' - - Data models: 'concepts/graph_data_models.md' - - LLM structured Outputs: "concepts/llm_structured_outputs.md" - Research: - "research.md" - Api reference: