hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-24 04:36:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation clean-up

Browse Source
This commit is contained in:
Stephan Brandauer
2023-04-27 14:41:43 +02:00
parent 52a8230ce3
commit adcf4a3dc2
4 changed files with 6 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
java/ql/src/Telemetry/AutomodelExtractCandidates.ql
View File

@@ -1,6 +1,6 @@
/**
* Surfaces the endpoints that pass the endpoint filters and are not already known to be sinks, and are therefore used
* as candidates for classification with an ML model.
* Surfaces the endpoints that are not already known to be sinks, and are therefore used as candidates for
* classification with an ML model.
*
* Note: This query does not actually classify the endpoints using the model.
*

2
java/ql/src/Telemetry/AutomodelExtractNegativeExamples.ql
View File

@@ -1,5 +1,5 @@
/**
* Surfaces endpoints are non-sinks with high confidence, for use as negative examples in the prompt.
* Surfaces endpoints that are non-sinks with high confidence, for use as negative examples in the prompt.
*
* @name Negative examples (experimental)
* @kind problem

9
java/ql/src/Telemetry/AutomodelExtractPositiveExamples.ql
View File

@@ -1,5 +1,5 @@
/**
* Surfaces endpoints are sinks with high confidence, for use as positive examples in the prompt.
* Surfaces endpoints that are sinks with high confidence, for use as positive examples in the prompt.
*
* @name Positive examples (experimental)
* @kind problem
@@ -13,13 +13,6 @@ private import semmle.code.java.security.ExternalAPIs as ExternalAPIs
private import AutomodelEndpointCharacteristics
private import AutomodelEndpointTypes
// private import experimental.adaptivethreatmodeling.ATMConfigs // To import the configurations of all supported Java queries
/*
* ****** WARNING: ******
* Before calling this query, make sure there's no codex-generated data extension file in `java/ql/lib/ext`. Otherwise,
* the ML-generated, noisy sinks will end up polluting the positive examples used in the prompt!
*/
from Endpoint sink, SinkType sinkType, string message
where
// Exclude endpoints that have contradictory endpoint characteristics, because we only want examples we're highly

4
java/ql/src/Telemetry/AutomodelSharedCharacteristics.qll
View File

@@ -16,7 +16,7 @@ signature module CandidateSig {
class EndpointType;
/** The string representing the file+range of the endpoint. */
/** Gets the string representing the file+range of the endpoint. */
string getLocationString(Endpoint e);
/**
@@ -64,7 +64,7 @@ signature module CandidateSig {
*
* This module is language-agnostic, although the `CandidateSig` module will be language-specific.
*
* The language specific implementation can also further extend the behaviour of this module by adding additional
* The language specific implementation can also further extend the behavior of this module by adding additional
* implementations of endpoint characteristics exported by this module.
*/
module SharedCharacteristics<CandidateSig Candidate> {